From dc48cc1a022fd9b4c7f9d1a360a9d4443f06cfe4 Mon Sep 17 00:00:00 2001 From: Bryan Bennett Date: Sat, 6 Sep 2014 15:01:42 -0400 Subject: [PATCH] Revert back to using RST --- README.md | 83 ------------------------------------------------------ README.rst | 78 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 78 insertions(+), 83 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index 92771b7..0000000 --- a/README.md +++ /dev/null @@ -1,83 +0,0 @@ -## vim-python-pep8-indent - - - - - - -This small script modifies [vim][vim]’s indentation behavior to comply with [PEP8][pep8] and -my aesthetic preferences: - -```python -foobar(foo, - bar) -``` - -and - -```python -foobar( - foo, - bar -) -``` - -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. - -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]. - -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. - -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. - -### Installation - -#### Pathogen -cd to `~/.vim/bundle` and -``` -git clone https://github.com/hynek/vim-python-pep8-indent.git -``` - -#### Vundle - -Follow the instructions on installing [Vundle][vundle] and add the appropriate -plugin line: - -``` -Plugin 'hynek/vim-python-pep8-indent` -``` - -#### 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 diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..917b40a --- /dev/null +++ b/README.rst @@ -0,0 +1,78 @@ +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 + +This small script modifies vim_’s indentation behavior to comply with PEP8_ and +my aesthetic preferences: :: python + +foobar(foo, + bar) + +and :: python + +foobar( + foo, + bar +) + +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. + +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_. + +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 well as I can, +provided they fit into the scope of this project. + +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. + +Installation +------------ + +Pathogen +######## +Follow the instructions on installing Pathogen_ and then :: + +cd ~/.vim/bundle +git clone https://github.com/hynek/vim-python-pep8-indent.git + +Vundle +###### + +Follow the instructions on installing Vundle_ and add the appropriate +plugin line: :: + +Plugin 'hynek/vim-python-pep8-indent` + +NeoBundle +######### + +Follow the instructions on installing 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 its 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 +.. _Neobundle: https://github.com/Shougo/neobundle.vim +.. _Pathogen: https://github.com/tpope/vim-pathogen +.. _python-mode: https://github.com/klen/python-mode +.. _`Vimscript`: http://learnvimscriptthehardway.stevelosh.com/ +.. _vundle: https://github.com/gmarik/Vundle.vim -- 2.39.2