add some tests

[etc/vim.git] / README.rst

diff --git a/README.rst b/README.rst
index ebcf4d4472246e7bd5c5f5a8348fdcffbf59dd13..d962240bf7719c52be4864cf4a4fcafa8f1acc47 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,8 +1,11 @@
 vim-python-pep8-indent
 ======================
 
-This small script that goes directly into `~/.vim/indent/` modifies vim_’s
-indentation behavior to comply with PEP8_: ::
+.. image:: https://travis-ci.org/hynek/vim-python-pep8-indent.png?branch=travis
+   :target: https://travis-ci.org/hynek/vim-python-pep8-indent
+
+This small script modifies vim_’s indentation behavior to comply with PEP8_ and
+my aesthetic preferences: ::
 
    foobar(foo,
           bar)
@@ -29,9 +32,25 @@ Unfortunately, I wasn’t able to reach any of the original authors/maintainers:
 work and release it hereby to the *Public Domain*. If anyone – who has a say in
 this – objects, please let me know.
 
+Installation
+------------
+
+The easiest way is to use pathogen_ and do a ::
+
+   git clone https://github.com/hynek/vim-python-pep8-indent.git
+
+in your `~/.vim/bundle`. And you *should* use pathogen. Really.
+
+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: ::
+
+   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/
 .. _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