1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-23 22:40:04 +08:00
SpaceVim/README.md

69 lines
3.5 KiB
Markdown
Raw Normal View History

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/) |
2017-08-24 04:08:11 +08:00
[Gitter **Chat**](https://gitter.im/SpaceVim/SpaceVim) |
[中文文档](http://spacevim.org/README_zh_cn/)
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-08-24 04:19:49 +08:00
SpaceVim is a community-driven vim distribution that seeks to provide layer feature, especially for neovim. It offers a variety of layers to choose from. to create a suitable vim development environment, you just need to select the required layers. If you use SpaceVim,
2017-01-14 13:06:18 +08:00
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-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
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-08-24 04:08:11 +08:00
### Install
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.
for more info about the install script, please check:
```bash
curl -sLf https://spacevim.org/install.sh | bash -s -- -h
```
2017-08-24 04:08:11 +08:00
### Features
2017-02-25 19:47:13 +08:00
2017-08-24 04:08:11 +08:00
- **Great documentation:** access documentation in Vim with
<kbd>:h SpaceVim</kbd>.
- **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.
- **Lazy load plugins:** Lazy-load 90% of plugins with [dein.vim](https://github.com/Shougo/dein.vim)
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-08-24 04:08:11 +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-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
- [![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.