From: Bryan Bennett <bbenne10@gmail.com>
Date: Fri, 5 Sep 2014 17:18:19 +0000 (-0400)
Subject: RST -> MD and add references to other installers
X-Git-Url: https://git.madduck.net/etc/vim.git/commitdiff_plain/0ec68e3bbb1c210dbb41f3c799fc538393277be9?ds=sidebyside

RST -> MD and add references to other installers

Added info for installing via NeoBundle and Vundle.
---

diff --git a/README.md b/README.md
index d962240..92771b7 100644
--- a/README.md
+++ b/README.md
@@ -1,56 +1,83 @@
-vim-python-pep8-indent
-======================
+## vim-python-pep8-indent                                                          
 
-.. image:: https://travis-ci.org/hynek/vim-python-pep8-indent.png?branch=travis
-   :target: https://travis-ci.org/hynek/vim-python-pep8-indent
+<a href="https://travis-ci.org/hynek/vim-python-pep8-indent">                      
+    <img src=https://travis-ci.org/hynek/vim-python-pep8-indent.png?branch=travis />
+</a>                                                                               
 
-This small script modifies vim_’s indentation behavior to comply with PEP8_ and
-my aesthetic preferences: ::
 
-   foobar(foo,
-          bar)
+This small script modifies [vim][vim]’s indentation behavior to comply with [PEP8][pep8] and 
+my aesthetic preferences:                                                          
 
-and ::
+```python                                                                          
+foobar(foo,                           
+       bar)                                                                        
+```                                                                                
 
-   foobar(
-      foo,
-      bar
-   )
+and                                                                                
 
-It was *not* originally written by me. I have found the script in vim’s `script
-repo`_, however the indentation was off by one character in the first case.
+```python                                                                          
+foobar(                                                                            
+    foo,                                                                           
+    bar                                                                            
+)                                                                                  
+```                                                                                
 
-I fixed it with the help of `Steve Losh`_ and am putting it out here so you
-don’t have to patch the original. The original patch is still available here_.
+It was *not* originally written by me. I have found the script in vim’s [script 
+repo][script_repo], however the indentation was off by one character in the first case.
 
-While my Vimscript_ skills are still feeble, I intend to maintain it for now.
-So feel free to report bugs, I’ll try to address them as good as possible if
-they fit into the scope of this project.
+I fixed it with the help of [Steve Losh][steve_losh] and am putting it out here so you 
+don’t have to patch the original. The original patch is still available [here][patch].
 
-Unfortunately, I wasn’t able to reach any of the original authors/maintainers:
-**David Bustos** and **Eric Mc Sween**. I’d like to thank them here for their
-work and release it hereby to the *Public Domain*. If anyone – who has a say in
-this – objects, please let me know.
+While my [Vimscript][vimscript] skills are still feeble, I intend to maintain it for now.
+So feel free to report bugs, I’ll try to address them as well as I can, provided
+they fit into the scope of this project.                                           
 
-Installation
-------------
+Unfortunately, I wasn’t able to reach any of the original authors/maintainers:  
+**David Bustos** and **Eric Mc Sween**. I’d like to thank them here for their   
+work and release it hereby to the *Public Domain*. If anyone with a say in this 
+objects, please let me know.                                                       
 
-The easiest way is to use pathogen_ and do a ::
+### Installation                                                                   
 
-   git clone https://github.com/hynek/vim-python-pep8-indent.git
+#### Pathogen                                                                      
+cd to `~/.vim/bundle` and                                                          
+```                                                                                
+git clone https://github.com/hynek/vim-python-pep8-indent.git                      
+```                                                                                
 
-in your `~/.vim/bundle`. And you *should* use pathogen. Really.
+#### Vundle                                                                        
 
-Please note that Kirill Klenov’s python-mode_ ships an own version of this bundle.
-Therefore, if you want to use this version specifically, you’ll have to disable python-mode’s using: ::
+Follow the instructions on installing [Vundle][vundle] and add the appropriate  
+plugin line:                                                                       
 
-   let g:pymode_indent = 0
+```                                                                                
+Plugin 'hynek/vim-python-pep8-indent`                                              
+```                                                                                
 
-.. _vim: http://www.vim.org/
-.. _PEP8: http://www.python.org/dev/peps/pep-0008/
-.. _`script repo`: http://www.vim.org/scripts/script.php?script_id=974
-.. _`Steve Losh`: http://stevelosh.com/
-.. _here: https://gist.github.com/2965846
-.. _`Vimscript`: http://learnvimscriptthehardway.stevelosh.com/
-.. _pathogen: https://github.com/tpope/vim-pathogen
-.. _python-mode: https://github.com/klen/python-mode
+#### NeoBundle                                                                     
+
+Follow the instructions on installing [NeoBundle][neobundle] and add the appropriate
+NeoBundle line:                                                                    
+
+```                                                                                
+NeoBundle 'hynek/vim-python-pep8-indent`                                           
+```                                                                                
+
+### Notes                                                                          
+
+Please note that Kirill Klenov’s [python-mode][python_mode]ships an own version of this bundle.
+Therefore, if you want to use this version specifically, you’ll have to disable python-mode’s using
+
+```                                                                                
+let g:pymode_indent = 0                                                            
+```                                                                                
+
+[vim]: http://www.vim.org/                                                         
+[pep8]: http://www.python.org/dev/peps/pep-0008/                                   
+[script_repo]: http://www.vim.org/scripts/script.php?script_id=974                 
+[steve_losh]: http://stevelosh.com/                                                
+[patch]: https://gist.github.com/2965846                                           
+[vimscript]: http://learnvimscriptthehardway.stevelosh.com/                        
+[pathogen]: https://github.com/tpope/vim-pathogen                                  
+[python_mode]: https://github.com/klen/python-mode                                 
+[vundle]: https://github.com/gmarik/Vundle.vim