mirror of
https://github.com/SpaceVim/SpaceVim.git
synced 2025-02-03 00:40:05 +08:00
0ecc2a2a8e
ref: https://github.com/SpaceVim/SpaceVim/issues/1390 Update readme Update readme Fix guide
146 lines
7.1 KiB
Markdown
146 lines
7.1 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/cn/)
|
|
|
|
[](https://travis-ci.org/SpaceVim/SpaceVim)
|
|
[](https://ci.appveyor.com/project/wsdjeg/spacevim/branch/master)
|
|
[](https://codecov.io/gh/SpaceVim/SpaceVim/branch/master)
|
|
|
|
[](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 modular vim distribution. It manages collections
|
|
of plugins in layers, which help collect related packages together to provide IDE-like features.
|
|
SpaceVim is not only a vimrc but an ultimate Vim configuration, It contains many build-in features.
|
|
|
|
|
|
|
|
See the [quick start guide](https://spacevim.org/quick-start-guide), [documentation](https://spacevim.org/documentation) or the [available 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 -->
|
|
|
|
- [New Features](#new-features)
|
|
- [Install](#install)
|
|
- [Project layout](#project-layout)
|
|
- [Support SpaceVim](#support-spacevim)
|
|
- [Credits & Thanks](#credits--thanks)
|
|
|
|
<!-- vim-markdown-toc -->
|
|
|
|
### New Features
|
|
|
|
This is a list of latest features implemented in SpaceVim:
|
|
|
|
**Highlight cursor symbol**
|
|
|
|
SpaceVim supports highlighting of the current symbol on demand and adds
|
|
a transient state to easily navigate and rename this symbol.
|
|
|
|
|
|
|
|
[**Fly Grep in Vim**](https://spacevim.org/grep-on-the-fly-in-spacevim/)
|
|
|
|
With this feature, vim will display the searching result as you type. Of course, it is running
|
|
asynchronously. Before using this feature, you need to install a searching tool. FlyGrep works
|
|
through search tools: `ag`, `rg`, `ack`, `pt` and `grep`, Choose one you like.
|
|
|
|
|
|
|
|
[**Mnemonic key bindings navigation**](http://spacevim.org/mnemonic-key-bindings-navigation/)
|
|
|
|
You don't need to remember any key bindings, as the mapping guide will show up after the <kbd>SPC</kbd> is pressed.
|
|
The mapping guide is also available for `g`, `z`, `s`, `f` and `F`.
|
|
|
|
|
|
|
|
[**Help description for key bindings**](http://spacevim.org/help-description-for-key-bindings/)
|
|
|
|
use <kbd>SPC h d k</kbd> to get the help description of a key binding, and `gd` to find definition of key bindings.
|
|
|
|
|
|
|
|
[**Asynchronous plugin manager**](http://spacevim.org/Asynchronous-plugin-manager/)
|
|
|
|
create an UI for [dein.vim](https://github.com/Shougo/dein.vim/) - the best asynchronous vim plugin manager
|
|
|
|
|
|
|
|
For more features, please read [SpaceVim's Blog](https://spacevim.org/blog/)
|
|
|
|
### Install
|
|
|
|
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).
|
|
|
|
**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
|
|
|
|
```txt
|
|
├─ autoload/SpaceVim/api/ APIs
|
|
├─ autoload/SpaceVim/layers/ layers
|
|
├─ autoload/SpaceVim/plugins/ plugins
|
|
├─ autoload/SpaceVim/mapping/ mapping guide
|
|
├─ doc/SpaceVim.txt help
|
|
├─ docs/ website(cn/en)
|
|
├─ wiki/ wiki(cn/en)
|
|
├─ bin/ executeable
|
|
└─ test/ tests
|
|
```
|
|
|
|
|
|
### 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)
|
|
- [@everettjf](https://github.com/everettjf) and his [SpaceVimTutorial](https://everettjf.gitbooks.io/spacevimtutorial/content/)
|
|
- [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.
|
|
|
|
<!-- vim:set nowrap: -->
|