Add the README

This commit is contained in:
Adam Stankiewicz 2013-09-13 14:06:28 +02:00
parent 22c93fbe3b
commit 7d52f93cad
2 changed files with 63 additions and 2 deletions

61
README.md Normal file
View File

@ -0,0 +1,61 @@
# vim-polyglot
Collection of language packs for Vim.
- It **won't affect your startup time**, as all files are loaded only on demand.
- Language packs are merged, not submoduled. It significantly speeds up installation time.
- No support for esoteric languages (there is for modern ones like `slim` though).
## Installation
1. Install pathogen, Vundle or NeoBundle package manager.
2. Use this repository as submodule or package.
## Language packs
- [arduino](https://github.com/sudar/vim-arduino-syntax)
- [bundler](https://github.com/tpope/vim-bundler)
- [clojure](https://github.com/guns/vim-clojure-static)
- [coffee-script](https://github.com/kchmck/vim-coffee-script)
- [csv](https://github.com/chrisbra/csv.vim)
- [cucumber](https://github.com/tpope/vim-cucumber)
- [elixir](https://github.com/elixir-lang/vim-elixir)
- [erlang](https://github.com/jimenezrick/vimerl)
- [git](https://github.com/tpope/vim-git)
- [haml](https://github.com/tpope/vim-haml)
- [handlebars](https://github.com/nono/vim-handlebars)
- [hasksyn](https://github.com/travitch/hasksyn)
- [javascript](https://github.com/pangloss/vim-javascript)
- [json](https://github.com/leshill/vim-json)
- [jst](https://github.com/briancollins/vim-jst)
- [less](https://github.com/groenewege/vim-less)
- [markdown](https://github.com/tpope/vim-markdown)
- [nginx](https://github.com/mutewinter/nginx.vim)
- [ocaml](https://github.com/jrk/vim-ocaml)
- [octave](https://github.com/vim-scripts/octave.vim--)
- [php](https://github.com/spf13/PIV)
- [puppet](https://github.com/ajf/puppet-vim)
- [python](https://github.com/vim-scripts/python.vim--Vasiliev)
- [rspec](https://github.com/skwp/vim-rspec)
- [ruby](https://github.com/vim-ruby/vim-ruby)
- [sbt](https://github.com/derekwyatt/vim-sbt)
- [scala](https://github.com/derekwyatt/vim-scala)
- [scss-syntax](https://github.com/cakebaker/scss-syntax.vim)
- [slim](https://github.com/slim-template/vim-slim)
- [stylus](https://github.com/wavded/vim-stylus)
- [textile](https://github.com/timcharper/textile.vim)
- [tmux](https://github.com/acustodioo/vim-tmux)
- [tomdoc](https://github.com/mutewinter/tomdoc.vim)
- [twig](https://github.com/beyondwords/vim-twig)
- [vim-golang](https://github.com/jnwhiteh/vim-golang)
- [xls](https://github.com/vim-scripts/XSLT-syntax)
## Contributing
Language packs are periodically updated using automated `build` script.
Feel free to add your language, and send pull-request.
## License
See linked repositories for detailed license information.

View File

@ -21,10 +21,10 @@ copy_dir() {
# Fetches syntax files from given Github repo
syntax() {
dir="tmp/$(echo "$1" | cut -d '/' -f 2)"
echo "$1..."
echo "- [$1](https://github.com/$1)"
rm -rf "$dir"
git clone -q --recursive "https://github.com/$1.git" "$dir"
which tree > /dev/null && tree tmp
# which tree > /dev/null && tree tmp
for subdir in $DIRS; do
copy_dir "$dir" "$subdir"