2017-02-25 15:27:15 +08:00
[](https://spacevim.org)
2017-10-07 22:57:35 +08:00
[Wiki ](https://github.com/SpaceVim/SpaceVim/wiki ) \|
[Documentation ](http://spacevim.org/documentation/ ) \|
[Twitter ](https://twitter.com/SpaceVim ) \|
[Community ](https://spacevim.org/community/ ) \|
[Gitter **Chat** ](https://gitter.im/SpaceVim/SpaceVim ) \|
2017-08-24 04:08:11 +08:00
[中文文档 ](http://spacevim.org/README_zh_cn/ )
2017-01-10 00:27:52 +08:00
2017-01-08 13:50:17 +08:00
[](https://travis-ci.org/SpaceVim/SpaceVim)
2017-10-09 23:14:53 +08:00
[](https://ci.appveyor.com/project/wsdjeg/spacevim/branch/dev)
2017-10-10 20:29:21 +08:00
[](https://codecov.io/gh/SpaceVim/SpaceVim/branch/dev)
2017-11-17 21:58:17 +08:00
2017-05-01 20:36:41 +08:00
[](LICENSE)
[](doc/SpaceVim.txt)
2017-05-01 14:09:17 +08:00
[](http://isitmaintained.com/project/SpaceVim/SpaceVim "Average time to resolve an issue")
[](http://isitmaintained.com/project/SpaceVim/SpaceVim "Percentage of issues still open")
2017-02-05 10:03:28 +08:00
2017-10-27 11:07:31 +08:00
SpaceVim is a community-driven vim distribution that supports vim and Neovim. SpaceVim manages collections of plugins in layers. Layers make it easy for you, the user, to enable a new language or feature by grouping all the related plugins together.
Please star the project on github - it is a great way to show your appreciation while providing us motivation to continue working on this project. The extra visibility for the project doesn't hurt either!
2017-01-04 21:04:42 +08:00
2017-05-24 20:02:46 +08:00
2017-02-25 16:57:35 +08:00
2017-08-24 04:01:43 +08:00
See the [documentation ](https://spacevim.org/documentation ) or [the list of layers ](http://spacevim.org/layers/ ) for more information.
2017-05-30 15:27:03 +08:00
2017-08-24 04:01:43 +08:00
Here is a throughput graph of the repository for the last few weeks:
2017-05-30 15:27:03 +08:00
2017-08-24 04:01:43 +08:00
[](https://waffle.io/SpaceVim/SpaceVim/metrics/throughput)
2017-05-30 15:27:03 +08:00
2017-10-01 20:32:36 +08:00
### Requirements
2017-10-27 11:07:31 +08:00
At a minimum, SpaceVim requires `git` to be installed. For a better graphical experience, install [nerd-font ](https://github.com/ryanoasis/nerd-fonts ) and make sure your terminal supports [true colors ](https://gist.github.com/XVilka/8346728 ).
2017-03-29 00:27:08 +08:00
2017-08-24 04:08:11 +08:00
### Install
2017-07-21 05:35:34 +08:00
2017-11-05 20:34:40 +08:00
#### Linux and macOS
2017-07-21 05:35:34 +08:00
```bash
curl -sLf https://spacevim.org/install.sh | bash
```
After SpaceVim is installed, launch `vim` and SpaceVim will **automatically** install plugins.
2017-09-29 10:21:29 +08:00
For more info about the install script, please check:
2017-07-21 05:35:34 +08:00
```bash
curl -sLf https://spacevim.org/install.sh | bash -s -- -h
```
2017-11-05 20:34:40 +08:00
#### Windows
The easist way is to download [install.cmd ](https://spacevim.org/install.cmd ) and run it as administrator, or install SpaceVim manually.
2017-10-10 19:34:54 +08:00
### Project layout
2017-11-13 17:07:00 +08:00
├─ autoload/SpaceVim/api/ APIs
├─ autoload/SpaceVim/layers/ layers
├─ autoload/SpaceVim/plugins/ plugins
├─ autoload/SpaceVim/mapping/ mapping guide
├─ doc/SpaceVim.txt help
├─ docs/ website
├─ wiki/ wiki
├─ bin/ executeable
└─ test/ tests
2017-10-10 19:34:54 +08:00
2017-08-24 04:08:11 +08:00
### Features
2017-02-25 19:47:13 +08:00
2017-10-16 23:22:48 +08:00
- **Great documentation:** access documentation in Vim with < kbd > SPC h SPC</ kbd > .
2017-08-24 04:08:11 +08:00
- **Beautiful GUI:** you'll love the awesome UI and its useful features.
2017-08-24 05:41:59 +08:00
- **Mnemonic key bindings:** all key bindings have mnemonic prefixes.
2017-10-13 22:03:08 +08:00
2017-10-28 21:49:44 +08:00
- **Describe key bindings:** use < kbd > SPC h d k</ kbd > to describe key bindings.
2017-08-24 05:41:59 +08:00
- **Lazy load plugins:** Lazy-load 90% of plugins with [dein.vim ](https://github.com/Shougo/dein.vim )
2017-10-07 22:57:35 +08:00
2017-08-24 04:08:11 +08:00
- **Neovim centric:** Dark powered mode of SpaceVim
2017-02-25 19:47:13 +08:00
2017-08-24 04:08:11 +08:00
### Support SpaceVim
2017-02-10 19:43:38 +08:00
2017-02-25 20:45:31 +08:00
The best way to support SpaceVim is to contribute to it either by reporting bugs, helping the community on the Gitter Chat or sending pull requests.
2017-09-29 10:21:29 +08:00
If you want to show your support financially you can buy a drink for the maintainer by clicking following icon.
2017-02-25 20:45:31 +08:00
2017-03-06 23:39:03 +08:00
< a href = 'https://ko-fi.com/A538L6H' target = '_blank' > < img height = '36' style = 'border:0px;height:36px;' src = 'https://az743702.vo.msecnd.net/cdn/kofi4.png?v=f' border = '0' alt = 'Buy Me a Coffee at ko-fi.com' / > < / a >
2017-02-25 20:45:31 +08:00
2017-11-13 17:07:00 +08:00
| wechat | alipay |
| ------------------------------------------------------------------------ | -------------------------------------------------------------------------- |
| < img src = "https://spacevim.org/img/weixin.png" height = "150" width = "150" > | < img src = "https://spacevim.org/img/zhifubao.png" height = "150" width = "150" > |
2017-11-26 20:41:37 +08:00
Bitcoin: 1DtuVeg81c2L9NEhDaVTAAbrCR3pN5xPFv
2017-08-24 04:08:11 +08:00
### Credits & Thanks
2017-07-21 05:35:34 +08:00
2017-02-10 19:43:38 +08:00
- [](https://github.com/SpaceVim/SpaceVim/graphs/contributors)
2017-10-01 20:53:57 +08:00
- [@Gabirel ](https://github.com/Gabirel ) and his [Hack-SpaceVim ](https://github.com/Gabirel/Hack-SpaceVim )
2017-02-10 19:43:38 +08:00
- [vimdoc ](https://github.com/google/vimdoc ) generate doc file for SpaceVim
- [Rafael Bodill ](https://github.com/rafi ) and his vim-config
- [Bailey Ling ](https://github.com/bling ) and his dotvim
2017-07-21 05:35:34 +08:00
- authors of all the plugins used in SpaceVim.
