Add documentation

Author: rapphil

README.md

@@ -1,41 +1,158 @@
-# Vim as a Python IDE
+# Contents
 
-This repo contains a script to build vim from the source, and install a set
-of plugins that will make VIM look like Python IDE.
+This project aims to use Vim as a powerful and complete Python IDE. In order
+to do that, we curated a list of awesome plugins available in the community and
+provided an automatic installation procedure for this set.
 
-Please check the available features and the plugins that enable them:
+<img src="./docs/img/vim.png?raw=true"/>
 
-## Syntax Highlighting
+## Installation
 
-## Color Themes
 
-## Project Navigation
+### Requirements for Ubuntu distros
 
-- Nerdtree
-- Tags
-- Fzf
+```bash
+sudo apt install libncurses5-dev libgnome2-dev libgnomeui-dev \
+libgtk2.0-dev libatk1.0-dev libbonoboui2-dev \
+libcairo2-dev libx11-dev libxpm-dev libxt-dev python-dev \
+python3-dev git
+```
 
-## Powerfull Full Text search
+### Requirements for Fedora distros
 
-- Ripgrep
+```bash
+sudo dnf install -y ctags git python python-devel \
+python3 python3-devel tcl-devel
+```
 
-## Real time linting
-- Ale
+### Installation process
 
-## Code navigation
+```bash
+git clone https://github.com/rapphil/vim-python-ide.git && \
+cd vim-python-ide && ./install.sh
+```
 
-- guttentag + jedi
+## Features
 
-## Code refactoring
+Please check the available features and the plugins that enable them.
 
-Jedi + Rope
-- Extract method
-- Rename functions
+### Syntax Highlighting
 
-## Code completion
-https://github.com/davidhalter/jedi-vim
-## Snippets
+Syntax highlighting for several languages, besides Python.
 
-Snippets save time while you type and create standardization
+Powered by:
 
-## Git Integration
+ * [vim-polyglot](https://github.com/sheerun/vim-polyglot)
+
+### Color Themes
+
+Several popular color schemes:
+
+ * Monokai
+ * Gruvbox
+ * Much more
+
+Powered by:
+
+ * [vim-colorschemes](https://github.com/flazz/vim-colorschemes)
+
+
+### Project Navigation
+
+Easily navigate your project using:
+
+ * File tree explore (Nerdtree)
+![Nerdtree](./img/nerdtree.gif)
+ * Fuzzy finder based on the file names
+![fuzzy-finder](./img/fzf.gif)
+ * File structure (classes, functions, methods).
+![tagbar](./img/tagbar.gif)
+Powered by:
+
+ * [Nerdtree](https://github.com/scrooloose/nerdtree)
+ * [Fzf](https://github.com/junegunn/fzf.vim)
+ * [Tagbar](https://majutsushi.github.io/tagbar/)
+
+### Powerfull Full Text search
+
+ * Full text search based on both exact match and fuzzy finder capabilities
+ * Extremely fast.
+![ripgrep](./img/ripgrep.gif)
+Powered by:
+
+ * [Ripgrep](https://github.com/BurntSushi/ripgrep)
+ * [Fzf](https://github.com/junegunn/fzf.vim)
+
+### Real time linting
+
+Lint source files in real time an check for errors and warnings.
+
+Powered by:
+
+ * [Ale](https://github.com/w0rp/ale)
+
+### Code navigation
+
+* Go to function definitions
+* Check parameters and docstrings easily.
+
+Powered by:
+
+* [vim-gutentags](https://github.com/ludovicchabant/vim-gutentags)
+* [jedi-vim](https://github.com/davidhalter/jedi-vim)
+
+### Code refactoring
+
+Extract methods, variables and rename functions easily.
+
+Powered by:
+
+ * [jedi-vim](https://github.com/davidhalter/jedi-vim)
+ * [rope-vim](https://github.com/python-rope/ropevim)
+
+### Code completion
+
+Use hints and dialog boxes to speed your development using code completion.
+
+Powered by:
+
+ * [jedi-vim](https://github.com/davidhalter/jedi-vim)
+
+### Snippets
+
+Snippets save time while you type and creates standardization for your code.
+
+Powered by:
+
+ * [vim-snippets](https://github.com/honza/vim-snippets)
+ * [ultisnips](https://github.com/SirVer/ultisnips)
+
+### Git Integration
+
+Perform git operations and highlight changes in the repo.
+
+Powered by:
+
+ * [vim-fugitive](https://github.com/tpope/vim-fugitive)
+ * [vim-gitgutter](https://github.com/airblade/vim-gitgutter)
+
+## Key bindings
+
+| Action                   | Mode             | key binding     |
+|--------------------------|------------------|-----------------|
+| Toogle Nerdtree          | Normal           | `crtl + n`      |
+| toogle Tagbar            | Normal           | `f8`            |
+| Look for file            | Normal           | `crtl + p`      |
+| Goto definition          | Normal           | `crtl + ]`      |
+| Show docstring           | Normal           | `K`             |
+| Extract method           | Normal/Visual    | `crlt + c r m`  |
+| Auto complete            | Insert           | `crtl + space`  |
+| Expand snippet           | Insert           |`tab`            |
+
+## Commands
+
+| Command Description            | Command        |
+|--------------------------------|----------------|
+| Look for string                | `:Rg <string>` |
+| git status                     | `:Gstatus`     |
+| git diff                       | `:Gdiff`        |

configs

@@ -53,3 +53,6 @@ let g:UltiSnipsExpandTrigger='<tab>'
 let g:UltiSnipsListSnippets='<c-tab>'
 let g:UltiSnipsJumpForwardTrigger='<c-j>'
 let g:UltiSnipsJumpBackwardTrigger='<c-k>'
+
+nmap <F8> :TagbarToggle<CR>
+

docs/img/fzf.gif

@@ -0,0 +1 @@
+../README.md

docs/img/nerdtree.gif

@@ -1,10 +1,11 @@
 #!/bin/bash
 
 VIM_VERSION="v8.1.0664"
-
 CURDIR=${PWD}
 CPUS=$(grep -c ^processor /proc/cpuinfo)
 
+read -p "Please backup your .vimrc file and .vim directory before starting. Press [Enter] to continue."
+
 git clone --branch $VIM_VERSION https://github.com/vim/vim.git /tmp/vim-build/
 cd /tmp/vim-build
 
@@ -17,6 +18,7 @@ pip2 install --user rope jedi ropevim flake8
 cp ${CURDIR}/vimrc ${HOME}/.vimrc
 
 UPDATE_PATH='export PATH=${HOME}/tools/vim/bin:$PATH'
+
 export PATH=${HOME}/tools/vim/bin:$PATH
 
 if grep -qF "$UPDATE_PATH" ${HOME}/.bashrc; then
@@ -25,11 +27,9 @@ else
 	echo "$UPDATE_PATH"  >> ${HOME}/.bashrc
 fi
 
-
 curl -fLo ~/.vim/autoload/plug.vim --create-dirs \
 	    https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
 
-
 vim -u ${CURDIR}/plugins +PlugInstall! +qall!
 
 cat ${CURDIR}/plugins ${CURDIR}/configs > ${HOME}/.vimrc

docs/img/ripgrep.gif

@@ -0,0 +1,10 @@
+site_name: Vim as a Python IDE
+site_author: "Raphael Philipe Mendes da Silva"
+site_description: "Small side project to provide an out-of-box Python IDE based on Vim and a set of community plugins"
+repo_url: "https://github.com/rapphil/vim-python-ide"
+
+google_analytics: ["UA-131814198-1", "auto"]
+theme: 
+  name: 'material'
+  feature:
+    tabs: true