2017-02-25 15:27:15 +08:00
[![SpaceVim ](https://spacevim.org/logo.png )](https://spacevim.org)
2017-04-18 18:06:36 +08:00
[Wiki ](https://github.com/SpaceVim/SpaceVim/wiki ) |
2017-02-25 15:27:15 +08:00
[Documentation ](http://spacevim.org/documentation/ ) |
[Twitter ](https://twitter.com/SpaceVim ) |
[Community ](https://spacevim.org/community/ ) |
[Gitter **Chat** ](https://gitter.im/SpaceVim/SpaceVim )
2017-01-10 00:27:52 +08:00
2017-01-08 13:50:17 +08:00
[![Build Status ](https://travis-ci.org/SpaceVim/SpaceVim.svg?branch=dev )](https://travis-ci.org/SpaceVim/SpaceVim)
2017-08-22 03:45:29 +08:00
![Version ](https://img.shields.io/badge/version-0.5.0--dev-FF00CC.svg )
2017-05-01 20:36:41 +08:00
[![MIT License ](https://img.shields.io/badge/license-MIT-blue.svg )](LICENSE)
[![Doc ](https://img.shields.io/badge/doc-%3Ah%20SpaceVim-orange.svg )](doc/SpaceVim.txt)
2017-05-01 14:09:17 +08:00
[![Average time to resolve an issue ](http://isitmaintained.com/badge/resolution/SpaceVim/SpaceVim.svg )](http://isitmaintained.com/project/SpaceVim/SpaceVim "Average time to resolve an issue")
[![Percentage of issues still open ](http://isitmaintained.com/badge/open/SpaceVim/SpaceVim.svg )](http://isitmaintained.com/project/SpaceVim/SpaceVim "Percentage of issues still open")
2017-02-05 10:03:28 +08:00
2017-02-25 16:57:35 +08:00
[SpaceVim ](https://github.com/SpaceVim/SpaceVim ) is a community-driven vim distribution with a bundle of modular configuration,
here we call these modules as layers, each layer has different plugins and config, users just need
2017-01-14 13:06:18 +08:00
to select the layers they need. It got inspired by [spacemacs ](https://github.com/syl20bnr/spacemacs ). If you use SpaceVim,
please star it on github. It's a great way of getting feedback and gives me the kick to
put more time into development.
2017-01-04 21:04:42 +08:00
2017-05-24 20:02:46 +08:00
![welcome-page ](https://cloud.githubusercontent.com/assets/13142418/26402270/28ad72b8-40bc-11e7-945e-003f41e057be.png )
2017-02-25 16:57:35 +08:00
- **Great documentation:** access documentation in Vim with
2017-02-25 20:13:39 +08:00
< kbd > :h SpaceVim< / kbd > .
2017-02-25 16:57:35 +08:00
- **Beautiful GUI:** you'll love the awesome UI and its useful features.
- **Mnemonic key bindings:** commands have mnemonic prefixes like
2017-02-25 20:13:39 +08:00
< kbd > [Window]< / kbd > for all the window and buffer commands or < kbd > [Unite]< / kbd > for the
unite work flow commands.
2017-02-25 16:57:35 +08:00
- **Lazy load plugins:** Lazy-load 90% of plugins with [dein.vim]
- **Batteries included:** discover hundreds of ready-to-use packages nicely
2017-02-25 20:13:39 +08:00
organised in configuration layers following a set of
[conventions ](http://spacevim.org/development/ ).
2017-02-25 19:47:13 +08:00
- **Neovim centric:** Dark powered mode of SpaceVim
2016-12-26 23:59:21 +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
[![Throughput Graph ](https://graphs.waffle.io/SpaceVim/SpaceVim/throughput.svg )](https://waffle.io/SpaceVim/SpaceVim/metrics/throughput)
2017-05-30 15:27:03 +08:00
2017-03-29 00:27:08 +08:00
2017-07-21 05:35:34 +08:00
## Install
```bash
curl -sLf https://spacevim.org/install.sh | bash
```
After SpaceVim is installed, launch `vim` and SpaceVim will **automatically** install plugins.
for more info about the install script, please check:
```bash
curl -sLf https://spacevim.org/install.sh | bash -s -- -h
```
2017-02-25 19:47:13 +08:00
## Community
2017-07-21 05:35:34 +08:00
Try these SpaceVim hangouts for any questions, problems or comments.
2017-02-10 19:43:38 +08:00
- Chat
- [![Gitter ](https://badges.gitter.im/SpaceVim/SpaceVim.svg )](https://gitter.im/SpaceVim/SpaceVim?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge)
- [![QQ ](https://img.shields.io/badge/QQ群-121056965-blue.svg )](https://jq.qq.com/?_wv=1027& k=43DB6SG)
- [![Facebook ](https://img.shields.io/badge/FaceBook-SpaceVim-blue.svg )](https://www.facebook.com/SpaceVim)
2017-07-21 05:35:34 +08:00
- Ask
- [issue tracker ](https://github.com/SpaceVim/SpaceVim/issues ) for issue and feature requests
- vi StackExchange for "how to" & configuration questions
- [![Twitter Follow ](https://img.shields.io/twitter/follow/SpaceVim.svg?style=social&label=Follow&maxAge=2592000 )](https://twitter.com/SpaceVim) for hugs & pithy comments
2017-02-10 19:43:38 +08:00
- Discuss
2017-03-06 20:23:48 +08:00
- [google mailing list ](https://groups.google.com/forum/#!forum/spacevim )
2017-02-10 19:43:38 +08:00
2017-02-21 21:21:04 +08:00
2017-02-25 19:47:13 +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.
If you want to show your support financially you can contribute to [Bountysource ](https://www.bountysource.com/teams/spacevim ) or buy a drink for the maintainer by clicking following icon.
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-03-06 23:39:03 +08:00
If you used SpaceVim in a project and you want to show that fact, you can use the SpaceVim badge:
2017-02-25 20:45:31 +08:00
[![ ](https://spacevim.org/img/build-with-SpaceVim.svg )](https://spacevim.org)
2017-02-10 19:43:38 +08:00
2017-02-25 20:45:31 +08:00
markdown
2017-07-21 05:35:34 +08:00
```markdown
2017-02-25 20:45:31 +08:00
[![ ](https://spacevim.org/img/build-with-SpaceVim.svg )](https://spacevim.org)
```
2017-02-10 19:43:38 +08:00
2017-02-25 19:47:13 +08:00
### contribute to SpaceVim
2017-02-25 21:23:27 +08:00
Before contributing be sure to consult the [contribution guidelines ](http://spacevim.org/development/#contribution-guidelines ) and [conventions ](http://spacevim.org/development/#conventions ).
2017-02-25 20:45:31 +08:00
2017-02-25 19:47:13 +08:00
## Credits & Thanks
2017-07-21 05:35:34 +08:00
2017-02-10 19:43:38 +08:00
- [![GitHub contributors ](https://img.shields.io/github/contributors/SpaceVim/SpaceVim.svg )](https://github.com/SpaceVim/SpaceVim/graphs/contributors)
- [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.