diff --git a/README.md b/README.md new file mode 100644 index 0000000..569f4d3 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +requirements.txt.vim +==================== + +[the Requirements File Format](http://pip.readthedocs.org/en/stable/reference/pip_install/#requirements-file-format) syntax support for Vim + +![requirements txt-sc](https://cloud.githubusercontent.com/assets/221802/11379923/5cbb4862-9336-11e5-8963-217b2d7df397.png) + +Installation +------------ + +### Plugin manager (**recommended**) + +e.g.) [NeoBundle](https://github.com/Shougo/neobundle.vim), [Vundle](https://github.com/VundleVim/Vundle.vim), [vim-plug](https://github.com/junegunn/vim-plug) [and more](https://dotfiles.github.io/) + +```vim +" NeoBundle +NeoBundle 'raimon49/requirements.txt.vim' + +" Vundle +Plugin 'raimon49/requirements.txt.vim' + +" vim-plug +Plug 'raimon49/requirements.txt.vim' +``` + +### Pathogen (https://github.com/tpope/vim-pathogen) + +```sh +$ git clone https://github.com/raimon49/requirements.txt.vim.git ~/.vim/bundle/requirements.txt.vim +``` + +### Manually + +Deploy all files under `$VIMRUNTIME` + +License +------- + +[MIT License](LICENSE.txt)