mirror of
https://github.com/SpaceVim/SpaceVim.git
synced 2025-01-23 17:30:04 +08:00
118 lines
6.5 KiB
Markdown
118 lines
6.5 KiB
Markdown
[](https://spacevim.org)
|
|
|
|
[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) \|
|
|
[中文文档](http://spacevim.org/README_zh_cn/)
|
|
|
|
[](https://travis-ci.org/SpaceVim/SpaceVim)
|
|
[](https://ci.appveyor.com/project/wsdjeg/spacevim/branch/dev)
|
|
[](https://codecov.io/gh/SpaceVim/SpaceVim/branch/dev)
|
|
|
|
[](LICENSE)
|
|
[](doc/SpaceVim.txt)
|
|
[](http://isitmaintained.com/project/SpaceVim/SpaceVim "Average time to resolve an issue")
|
|
[](http://isitmaintained.com/project/SpaceVim/SpaceVim "Percentage of issues still open")
|
|
|
|
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!
|
|
|
|
|
|
|
|
See the [documentation](https://spacevim.org/documentation) or [the list of layers](http://spacevim.org/layers/) for more information.
|
|
|
|
Here is a throughput graph of the repository for the last few weeks:
|
|
|
|
[](https://waffle.io/SpaceVim/SpaceVim/metrics/throughput)
|
|
|
|
<!-- vim-markdown-toc GFM -->
|
|
|
|
- [Requirements](#requirements)
|
|
- [Install](#install)
|
|
- [Linux and macOS](#linux-and-macos)
|
|
- [Windows](#windows)
|
|
- [Project layout](#project-layout)
|
|
- [Features](#features)
|
|
- [Support SpaceVim](#support-spacevim)
|
|
- [Credits & Thanks](#credits--thanks)
|
|
|
|
<!-- vim-markdown-toc -->
|
|
|
|
### Requirements
|
|
|
|
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).
|
|
|
|
### Install
|
|
|
|
#### Linux and macOS
|
|
|
|
```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
|
|
```
|
|
|
|
#### Windows
|
|
|
|
The easist way is to download [install.cmd](https://spacevim.org/install.cmd) and run it as administrator, or install SpaceVim manually.
|
|
|
|
### Project layout
|
|
|
|
├─ 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
|
|
|
|
### Features
|
|
|
|
- **Great documentation:** access documentation in Vim with <kbd>SPC h SPC</kbd>.
|
|
|
|
- **Beautiful UI:** you'll love the awesome UI and its useful features.
|
|
|
|
- **Mnemonic key bindings:** all key bindings have mnemonic prefixes.
|
|
|
|
- **Describe key bindings:** use <kbd>SPC h d k</kbd> to describe key bindings, and find definition of key bindings.
|
|
|
|
- **Lazy load plugins:** Lazy-load 90% of plugins with [dein.vim](https://github.com/Shougo/dein.vim)
|
|
|
|
- **Awesome statusline:** a heavily customized modular statusline.
|
|
|
|
- **Neovim centric:** Dark powered mode of SpaceVim
|
|
|
|
### Support SpaceVim
|
|
|
|
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 buy a drink for the maintainer by clicking following icon.
|
|
|
|
<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>
|
|
|
|
| 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"> |
|
|
|
|
Bitcoin: 1DtuVeg81c2L9NEhDaVTAAbrCR3pN5xPFv
|
|
|
|
### Credits & Thanks
|
|
|
|
- [](https://github.com/SpaceVim/SpaceVim/graphs/contributors)
|
|
- [@Gabirel](https://github.com/Gabirel) and his [Hack-SpaceVim](https://github.com/Gabirel/Hack-SpaceVim)
|
|
- [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
|
|
- authors of all the plugins used in SpaceVim.
|