From 04ff9640ac3c07f0062f6eefc9d2bae2b9c5297e Mon Sep 17 00:00:00 2001
From: Simon Vieille <simon@deblan.fr>
Date: Tue, 7 Feb 2017 00:08:38 +0100
Subject: [PATCH] Documentation

---
 README.md | 48 +++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 43 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 5e2cf05..ce138e2 100644
--- a/README.md
+++ b/README.md
@@ -5,22 +5,60 @@ Made for php developments.
 
 ## Installation
 
+First, move to your home directory: `cd $HOME`
+
+### Dependencies
+
+```
+$ PACKAGE_MANAGER=apt # Depending of your system…
+$ sudo $PACKAGE_MANAGER install \
+vim \
+vim-athena \
+vim-common \
+vim-gtk \
+vim-gui-common \
+vim-nox \
+vim-runtime \
+vim-scripts \
+vim-tiny \
+wget \
+git \
+exuberant-ctags
+$ wget https://github.com/FriendsOfPHP/PHP-CS-Fixer/releases/download/v1.12.3/php-cs-fixer.phar
+$ chmod +x php-cs-fixer.phar
+```
+
+Notify me if I forgot something :)
+
+**Do backups if needed:**
+
 ```
-$ sudo apt install vim vim vim-addon-manager vim-athena vim-common vim-fugitive vim-gtk vim-gui-common vim-nox vim-runtime vim-scripts vim-tiny
-$ cd $HOME
 $ [ -f .vimrc ] && mv .vimrc .vimrc-back
 $ [ -d .vim ] && mv .vim .vim-back
+```
+
+### Cloning the configuration
+
+```
 $ git clone https://gitnet.fr/deblan/dotvim deblan-vim
 $ ln -rs deblan-vim/vimrc .vimrc
 $ ln -rs deblan-vim/vim .vim
+```
+
+### Plugins
+
+```
 $ git clone https://github.com/VundleVim/Vundle.vim.git .vim/bundle/Vundle.vim
 $ vim +PluginInstall +qall
 ```
 
-You will need to edit `.vimrc`:
-
+### Hack the conf!
 
 * `let g:snips_author = "Your username"`
 * `let g:snips_email = "Your email"`
 * `let g:snips_github = "Your website"`
-* `set guifont=Fantasque\ Sans\ Mono\ 14`
+
+GVim are configured to use `Fantasque Sans Mono`: https://fontlibrary.org/en/font/fantasque-sans-mono
+If you want to use another one, edit `set guifont=Fantasque\ Sans\ Mono\ 14`.
+
+`F1` is mapped to run a script named `indentation`. It's a personal and ugly script that indents the html, css and javascript. If you want to use it, you must install `node` and run `sudo cp .vim/bin/* /usr/local/bin/`.