From 246206019bc72b9119b7043cadd61cf4ea0604a0 Mon Sep 17 00:00:00 2001
From: Akshay <nerdypepper@tuta.io>
Date: Tue, 14 Apr 2020 11:09:40 +0530
Subject: update docs

---
 INSTALL.md                 |  4 ++--
 README.md                  | 18 +++++++++++++++---
 ligature_plugins/README.md | 26 +++++++++-----------------
 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.
 
  2. Extract the release package:
 ```shell
-tar xzf scientifica-v1.2.tar.gz
+tar xf scientifica-v1.2.tar.gz
 ```
 
 3. 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
 
 Check if your installation procedure was a success:
 
- 1. Run `fc-list | grep sci`
+ 1. Run `fc-list | grep scientifica`
  2. If the output is **not** null, congrats!
  3. Proceed to [Troubleshooting](#troubleshooting) if the output is empty
 
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.
 
  - Scaleable `ttf` format
  - Raster formats: `otb` and `bdf`
+ - Ligatures (vim and neovim only)
  - **Bold** and *Italic* variants
  - New Characters to the following unicode blocks:
    * Geometric Shapes
@@ -34,9 +35,13 @@ low dpi(90-120) displays.
 
 ## Gallery
 
-| ![sample image](./img/sci4.png)  | ![sample image](./img/sci2.png)  | ![sample image](./img/sci3.png)          | ![sample image](./img/sci1.png)  |
-| -------------------------------- | -------------------------------- | --------------------------------         | -------------------------------- |
-| Programming                      | Box Drawings                     | Latin, Polish, Slovakian, French, German | Powerline glyphs                 |
+| ![sample image](./img/sci4.png)  | ![sample image](./img/sci2.png)  | ![sample image](./img/sci3.png)          |
+| -------------------------------- | -------------------------------- | --------------------------------         |
+| Programming                      | Box Drawings                     | Latin, Polish, Slovakian, French, German |
+
+| ![sample image](./img/sci1.png)  | ![sample image](./img/sci5.png)          |
+| -------------------------------- | --------------------------------         |
+| Powerline Glyphs                 | Ligatures (Rust, Python, Haskell, Ocaml) |
 
 
 ## Installation
@@ -44,6 +49,13 @@ low dpi(90-120) displays.
 Installation instructions have been moved to
 [`INSTALL.md`](INSTALL.md).
 
+## Ligatures
+
+Scientifica supports ligatures in Vim and Neovim via the
+conceal feature. Please read the
+[Ligatures](ligature_plugins/README.md)
+manual for instructions.
+
 
 ## Credits
 
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 @@
 # Ligature and Unicode substitution
 
-These features are supported *in (neo)vim only*.
+These features are supported in {neo,}vim only.
 
 ### Installation
 
-Symlink the required vim plugins to
+Copy the required vim plugins to
 
  - `~/.vim/after/syntax/` (vim)
  - `~/.config/nvim/after/syntax/` (neovim)
 
  ```shell
- #vim
- cd ~/scientifica/ligature_plugins/
- for i in `ls` ; do
- ln -sf ~/scientifica/ligature_plugins/"$i" ~/.vim/after/syntax/"$i"
- done
-
- #nvim
- cd ~/scientifica/ligature_plugins/
- for i in `ls` ; do
- ln -sf ~/scientifica/ligature_plugins/"$i" ~/.config/nvim/after/syntax/"$i"
- done
+# the rust plugin for example:
+mkdir -p ~/.vim/after/syntax
+cp ligature_plugins/rust.vim ~/.vim/after/syntax/
  ```
 
-Credits go to [romeovs](https://github.com/romeovs/) for the haskell plugin.  
-Credits go to [ehamberg](https://github.com/ehamberg/vim-cute-python) for the python plugin.
+If you have `set conceallevel=0` if your `vimrc`, remove it.
 
-Both plugins have been modified (haskell.vim especially) to play well with scientifica.  
-If you need ligatures for other languages, just open an issue, with the language and the ligature sequence.
+Big thanks to [romeovs](https://github.com/romeovs/) for
+creating the haskell plugin and the idea of ligatures via
+conceals.
-- 
cgit v1.2.3