From b35158ce60b08d3170a473e29e658e7e88b89f7a Mon Sep 17 00:00:00 2001
From: iGor milhit <igor@milhit.ch>
Date: Wed, 16 Aug 2017 12:10:24 +0200
Subject: [PATCH] feat: add rst live preview and document setup

---
 README.md | 36 ++++++++++++++++++++++++++++++++++--
 init.vim  |  1 +
 2 files changed, 35 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 18f17b6..7990f7f 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,40 @@
 
 Having used `neovim` for a few month, with symlinks for the configuration and the plugins, I want to start a new setup.
 
-Firstly, I don't use any more `pathogen` for the management of plugins, but `vim-plug` instead.
+Firstly, I don't use any more `pathogen` for the management of plugins, but `vim-plug` instead. To install `vim-plug` see the [documentation](https://github.com/junegunn/vim-plug/blob/master/README.md#neovim).
 
-For `vim-livedown`, the `npm` `livedown` package needs to be installed globally:
+## Requirements
+
+1. `neovim`
+2. `git`
+3. `nodejs` et `npm`
+
+## Installation
+
+1. clone the repository
+2. create a symlink
+3. start `neovim`
+4. install the plugins
+5. check the requirements
+
+``` bash
+git clone <URL>
+ln -s neovim .config/neovim
+nvim
+:PlugInstall
+```
+
+## Requirements for the plugins used
+
+For `vim-colors-solarized`, a symlink is needed:
+
+``` bash
+cd $HOME/neovim/colors #or the dir. where you've clone this repository
+ln -s ../plugged/vim-colors-solarized/colors/solarized.vim solarized.vim
+```
+
+For `vim-livedown`, the `node` `livedown` package needs to be installed globally:
 
 `npm install -g livedown`
+
+For `InstantRst`, the python package `instant-rst` is needed. See the [documentation](https://github.com/Rykka/InstantRst#1install).
diff --git a/init.vim b/init.vim
index 1783efb..d2c4359 100644
--- a/init.vim
+++ b/init.vim
@@ -60,6 +60,7 @@ Plug 'https://github.com/elzr/vim-json.git'
 Plug 'https://github.com/tpope/vim-commentary'
 Plug 'https://github.com/osyo-manga/vim-over', { 'on': 'OverCommandLine' }
 Plug 'https://github.com/Rykka/riv.vim'
+Plug 'https://github.com/Rykka/InstantRst'
 call plug#end()