aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAkshay <[email protected]>2020-04-14 06:39:40 +0100
committerAkshay <[email protected]>2020-04-14 06:39:40 +0100
commit246206019bc72b9119b7043cadd61cf4ea0604a0 (patch)
treef11614d8e060c539c23b749de8f5b8e4d33ed695
parent4a10982b8fa6c4e68ac21955f9e0f8706ccfb1c7 (diff)
update docs
-rw-r--r--INSTALL.md4
-rw-r--r--README.md18
-rw-r--r--ligature_plugins/README.md26
3 files changed, 26 insertions, 22 deletions
diff --git a/INSTALL.md b/INSTALL.md
index df9831d..624b542 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -28,7 +28,7 @@ page.
28 28
29 2. Extract the release package: 29 2. Extract the release package:
30```shell 30```shell
31tar xzf scientifica-v1.2.tar.gz 31tar xf scientifica-v1.2.tar.gz
32``` 32```
33 33
343. You may install either the `ttf`s or the `otb`s or the 343. You may install either the `ttf`s or the `otb`s or the
@@ -76,7 +76,7 @@ user@host$ BNP="/home/nerdypepper/BitsNPicas.jar" ./build.sh
76 76
77Check if your installation procedure was a success: 77Check if your installation procedure was a success:
78 78
79 1. Run `fc-list | grep sci` 79 1. Run `fc-list | grep scientifica`
80 2. If the output is **not** null, congrats! 80 2. If the output is **not** null, congrats!
81 3. Proceed to [Troubleshooting](#troubleshooting) if the output is empty 81 3. Proceed to [Troubleshooting](#troubleshooting) if the output is empty
82 82
diff --git a/README.md b/README.md
index bb8b029..9a33493 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,7 @@ low dpi(90-120) displays.
18 18
19 - Scaleable `ttf` format 19 - Scaleable `ttf` format
20 - Raster formats: `otb` and `bdf` 20 - Raster formats: `otb` and `bdf`
21 - Ligatures (vim and neovim only)
21 - **Bold** and *Italic* variants 22 - **Bold** and *Italic* variants
22 - New Characters to the following unicode blocks: 23 - New Characters to the following unicode blocks:
23 * Geometric Shapes 24 * Geometric Shapes
@@ -34,9 +35,13 @@ low dpi(90-120) displays.
34 35
35## Gallery 36## Gallery
36 37
37| ![sample image](./img/sci4.png) | ![sample image](./img/sci2.png) | ![sample image](./img/sci3.png) | ![sample image](./img/sci1.png) | 38| ![sample image](./img/sci4.png) | ![sample image](./img/sci2.png) | ![sample image](./img/sci3.png) |
38| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | 39| -------------------------------- | -------------------------------- | -------------------------------- |
39| Programming | Box Drawings | Latin, Polish, Slovakian, French, German | Powerline glyphs | 40| Programming | Box Drawings | Latin, Polish, Slovakian, French, German |
41
42| ![sample image](./img/sci1.png) | ![sample image](./img/sci5.png) |
43| -------------------------------- | -------------------------------- |
44| Powerline Glyphs | Ligatures (Rust, Python, Haskell, Ocaml) |
40 45
41 46
42## Installation 47## Installation
@@ -44,6 +49,13 @@ low dpi(90-120) displays.
44Installation instructions have been moved to 49Installation instructions have been moved to
45[`INSTALL.md`](INSTALL.md). 50[`INSTALL.md`](INSTALL.md).
46 51
52## Ligatures
53
54Scientifica supports ligatures in Vim and Neovim via the
55conceal feature. Please read the
56[Ligatures](ligature_plugins/README.md)
57manual for instructions.
58
47 59
48## Credits 60## Credits
49 61
diff --git a/ligature_plugins/README.md b/ligature_plugins/README.md
index 59beda8..7173d61 100644
--- a/ligature_plugins/README.md
+++ b/ligature_plugins/README.md
@@ -1,30 +1,22 @@
1# Ligature and Unicode substitution 1# Ligature and Unicode substitution
2 2
3These features are supported *in (neo)vim only*. 3These features are supported in {neo,}vim only.
4 4
5### Installation 5### Installation
6 6
7Symlink the required vim plugins to 7Copy the required vim plugins to
8 8
9 - `~/.vim/after/syntax/` (vim) 9 - `~/.vim/after/syntax/` (vim)
10 - `~/.config/nvim/after/syntax/` (neovim) 10 - `~/.config/nvim/after/syntax/` (neovim)
11 11
12 ```shell 12 ```shell
13 #vim 13# the rust plugin for example:
14 cd ~/scientifica/ligature_plugins/ 14mkdir -p ~/.vim/after/syntax
15 for i in `ls` ; do 15cp ligature_plugins/rust.vim ~/.vim/after/syntax/
16 ln -sf ~/scientifica/ligature_plugins/"$i" ~/.vim/after/syntax/"$i"
17 done
18
19 #nvim
20 cd ~/scientifica/ligature_plugins/
21 for i in `ls` ; do
22 ln -sf ~/scientifica/ligature_plugins/"$i" ~/.config/nvim/after/syntax/"$i"
23 done
24 ``` 16 ```
25 17
26Credits go to [romeovs](https://github.com/romeovs/) for the haskell plugin. 18If you have `set conceallevel=0` if your `vimrc`, remove it.
27Credits go to [ehamberg](https://github.com/ehamberg/vim-cute-python) for the python plugin.
28 19
29Both plugins have been modified (haskell.vim especially) to play well with scientifica. 20Big thanks to [romeovs](https://github.com/romeovs/) for
30If you need ligatures for other languages, just open an issue, with the language and the ligature sequence. 21creating the haskell plugin and the idea of ligatures via
22conceals.