1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-02-02 22:10:06 +08:00

Improve readme

This commit is contained in:
wsdjeg 2018-01-30 20:33:04 +08:00
parent bbcf120c91
commit fe629b3402
9 changed files with 138 additions and 93 deletions

View File

@ -26,5 +26,7 @@ else
if [ "$LINT" = "jekyll" ]; then if [ "$LINT" = "jekyll" ]; then
./wiki/async.sh "en" ./wiki/async.sh "en"
./wiki/async.sh "cn" ./wiki/async.sh "cn"
git remote add gitee https://SpaceVimBot:${BOTSECRET}@gitee.com/spacevim/SpaceVim.git
git push gitee master
fi fi
fi fi

View File

@ -16,55 +16,60 @@
[![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") [![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") [![Percentage of issues still open](http://isitmaintained.com/badge/open/SpaceVim/SpaceVim.svg)](http://isitmaintained.com/project/SpaceVim/SpaceVim "Percentage of issues still open")
SpaceVim is a distribution of the vim editor that's inspired by spacemacs. It manages collections of plugins in layers, which help collect related packages together to provide features. For example, the python layer collects deoplete.nvim, neomake and jedi-vim together to provides autocompletion, syntax checking, and documentation lookup. This approach helps keep configuration organized and reduces overhead for the user by keeping them from having to think about what packages to install. SpaceVim is a distribution of the vim editor that's inspired by spacemacs. It manages collections
of plugins in layers, which help collect related packages together to provide features. This
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! approach helps keep configuration organized and reduces overhead for the user by keeping them
from having to think about what packages to install.
![welcome-page](https://user-images.githubusercontent.com/13142418/33793078-3446cb6e-dc76-11e7-9998-376a355557a4.png) ![welcome-page](https://user-images.githubusercontent.com/13142418/33793078-3446cb6e-dc76-11e7-9998-376a355557a4.png)
See the [Quick start guide](https://spacevim.org/quick-start-guide), [documentation](https://spacevim.org/documentation) or [the list of layers](http://spacevim.org/layers/) for more information. 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: Here is a throughput graph of the repository for the last few weeks:
[![Throughput Graph](https://graphs.waffle.io/SpaceVim/SpaceVim/throughput.svg)](https://waffle.io/SpaceVim/SpaceVim/metrics/throughput) [![Throughput Graph](https://graphs.waffle.io/SpaceVim/SpaceVim/throughput.svg)](https://waffle.io/SpaceVim/SpaceVim/metrics/throughput)
<!-- vim-markdown-toc GFM --> <!-- vim-markdown-toc GFM -->
- [Features](#features) - [Features](#features)
- [Requirements](#requirements)
- [Install](#install) - [Install](#install)
- [Linux and macOS](#linux-and-macos) - [Linux and macOS](#linux-and-macos)
- [Windows](#windows) - [Windows](#windows)
- [Project layout](#project-layout) - [Project layout](#project-layout)
- [Blogs](#blogs)
- [Support SpaceVim](#support-spacevim) - [Support SpaceVim](#support-spacevim)
- [Credits & Thanks](#credits--thanks) - [Credits & Thanks](#credits--thanks)
<!-- vim-markdown-toc --> <!-- vim-markdown-toc -->
### Features ## Features
- **Great documentation:** access documentation in Vim with <kbd>SPC h SPC</kbd>. [**Mnemonic key bindings navigation**](http://spacevim.org/mnemonic-key-bindings-navigation/)
![SPC h SPC](https://user-images.githubusercontent.com/13142418/31620230-48b53eea-b2c9-11e7-90d0-b717878875d4.gif)
- **Beautiful UI:** you'll love the awesome UI and its useful features.
![beautiful UI](https://user-images.githubusercontent.com/13142418/33804722-bc241f50-dd70-11e7-8dd8-b45827c0019c.png)
- **Mnemonic key bindings:** all key bindings have mnemonic prefixes.
![mapping guide](https://user-images.githubusercontent.com/13142418/31550099-c8173ff8-b062-11e7-967e-6378a9c3b467.gif)
- **Describe key bindings:** use <kbd>SPC h d k</kbd> to describe key bindings, and find definition of key bindings.
![describe key](https://user-images.githubusercontent.com/13142418/33804739-52dbc498-dd71-11e7-97e5-ed0fa6ec1719.gif)
- **Lazy load plugins:** Lazy-load 90% of plugins with [dein.vim](https://github.com/Shougo/dein.vim)
![UI for dein](https://user-images.githubusercontent.com/13142418/31309093-36c01150-abb3-11e7-836c-3ad406bdd71a.gif)
- **Awesome statusline:** a heavily customized modular statusline.
![statusline](https://user-images.githubusercontent.com/13142418/33804880-b9177142-dd73-11e7-82d5-1780dc27e7e3.png)
- **Neovim centric:** Dark powered mode of SpaceVim
### Requirements 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`.
![mapping guide](https://user-images.githubusercontent.com/13142418/35568184-9a318082-058d-11e8-9d88-e0eafd1d498d.gif)
[**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.
![describe key bindings](https://user-images.githubusercontent.com/13142418/35568829-e3c8e74c-058f-11e8-8fa8-c0e046d8add3.gif)
[**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
![UI for dein](https://user-images.githubusercontent.com/13142418/34907332-903ae968-f842-11e7-8ac9-07fcc9940a53.gif)
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). 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
#### Linux and macOS
```bash ```bash
curl -sLf https://spacevim.org/install.sh | bash curl -sLf https://spacevim.org/install.sh | bash
@ -78,11 +83,11 @@ For more info about the install script, please check:
curl -sLf https://spacevim.org/install.sh | bash -s -- -h curl -sLf https://spacevim.org/install.sh | bash -s -- -h
``` ```
#### Windows ### Windows
The easist way is to download [install.cmd](https://spacevim.org/install.cmd) and run it as administrator, or install SpaceVim manually. The easist way is to download [install.cmd](https://spacevim.org/install.cmd) and run it as administrator, or install SpaceVim manually.
### Project layout ## Project layout
```txt ```txt
├─ autoload/SpaceVim/api/ APIs ├─ autoload/SpaceVim/api/ APIs
@ -90,25 +95,20 @@ The easist way is to download [install.cmd](https://spacevim.org/install.cmd) an
├─ autoload/SpaceVim/plugins/ plugins ├─ autoload/SpaceVim/plugins/ plugins
├─ autoload/SpaceVim/mapping/ mapping guide ├─ autoload/SpaceVim/mapping/ mapping guide
├─ doc/SpaceVim.txt help ├─ doc/SpaceVim.txt help
├─ docs/ website ├─ docs/ website(cn/en)
├─ wiki/ wiki ├─ wiki/ wiki(cn/en)
├─ bin/ executeable ├─ bin/ executeable
└─ test/ tests └─ test/ tests
``` ```
### Blogs ## Support SpaceVim
- [Use Vim as a Java IDE](http://spacevim.org/use-vim-as-a-java-ide/) The best way to support SpaceVim is to contribute to it either by reporting bugs,
- [An async code runner in SpaceVim](http://spacevim.org/async-code-runner-in-SpaceVim/) helping the community on the Gitter Chat or sending pull requests.
More posts are in the [SpaceVim's Blog](https://spacevim.org/blog/) If you want to show your support financially you can buy a drink for the maintainer by
clicking following icon.
### 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> <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>
@ -118,10 +118,11 @@ If you want to show your support financially you can buy a drink for the maintai
Bitcoin: 1DtuVeg81c2L9NEhDaVTAAbrCR3pN5xPFv Bitcoin: 1DtuVeg81c2L9NEhDaVTAAbrCR3pN5xPFv
### Credits & Thanks ## Credits & Thanks
- [![GitHub contributors](https://img.shields.io/github/contributors/SpaceVim/SpaceVim.svg)](https://github.com/SpaceVim/SpaceVim/graphs/contributors) - [![GitHub contributors](https://img.shields.io/github/contributors/SpaceVim/SpaceVim.svg)](https://github.com/SpaceVim/SpaceVim/graphs/contributors)
- [@Gabirel](https://github.com/Gabirel) and his [Hack-SpaceVim](https://github.com/Gabirel/Hack-SpaceVim) - [@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 - [vimdoc](https://github.com/google/vimdoc) generate doc file for SpaceVim
- [Rafael Bodill](https://github.com/rafi) and his vim-config - [Rafael Bodill](https://github.com/rafi) and his vim-config
- [Bailey Ling](https://github.com/bling) and his dotvim - [Bailey Ling](https://github.com/bling) and his dotvim

View File

@ -7,3 +7,39 @@ comments: true
--- ---
# Mnemonic key bindings navigation # Mnemonic key bindings navigation
You don't need to remember any key bindings, as a guide buffer is displayed each time the prefix key is pressed
in normal/visual mode. It lists the available key bindings and their short description.
The prefix can be `[SPC]`, `[Window]`, `[denite]`, `<leader>` and `[unite]`, when the guide is opened, you can
see the prefix on the statusline.
![mapping guide](https://user-images.githubusercontent.com/13142418/35568184-9a318082-058d-11e8-9d88-e0eafd1d498d.gif)
## default key binding prefixes
| Prefix name | custom option and default value | description |
| ----------- | --------------------------------- | ----------------------------------- |
| `[SPC]` | NONE / `<Space>` | default mapping prefix of SpaceVim |
| `[Window]` | `g:spacevim_windows_leader` / `s` | window mapping prefix of SpaceVim |
| `[denite]` | `g:spacevim_denite_leader` / `F` | denite mapping prefix of SpaceVim |
| `[unite]` | `g:spacevim_unite_leader` / `f` | unite mapping prefix of SpaceVim |
| `<leader>` | `mapleader` / `` \ `` | default leader prefix of vim/neovim |
By default the guide buffer will be displayed 1000ms after the key has been pressed. You can change the delay by setting `'timeoutlen'` option to your liking (the value is in milliseconds).
for example, after pressing `<Space>` in normal mode, you will see :
![mapping-guide](https://cloud.githubusercontent.com/assets/13142418/25778673/ae8c3168-3337-11e7-8536-ee78d59e5a9c.png)
this guide show you all the available key bindings begin with `[SPC]`, you can type `b` for all the buffer mappings, `p` for project mappings, etc.
## Get paging and help info
after pressing `<C-h>` in guide buffer, you will get paging and help info in the statusline.
| key | description |
| --- | ----------------------------- |
| `u` | undo pressing |
| `n` | next page of guide buffer |
| `p` | previous page of guide buffer |

View File

@ -6,8 +6,11 @@ image: https://user-images.githubusercontent.com/13142418/34907415-c2cf7e88-f843
comments: true comments: true
--- ---
# Mnemonic key bindings navigation # Help description for key bindings
Use `SPC h d k` to start a input prompt, Then press the key bindings you want to describe. Use `SPC h d k` to start a input prompt, Then press the key bindings you want to describe.
![help description for key bindings](https://user-images.githubusercontent.com/13142418/34907415-c2cf7e88-f843-11e7-92d3-ef0f9b1b72ae.gif) ![help description for key bindings](https://user-images.githubusercontent.com/13142418/34907415-c2cf7e88-f843-11e7-92d3-ef0f9b1b72ae.gif)
sometimes, you want to know the help description of a key binding and the definition of this key binding. this feature help you to quick get
these info.

View File

@ -13,7 +13,7 @@ lang: cn
- [可移植性](#可移植性) - [可移植性](#可移植性)
- [字符串](#字符串) - [字符串](#字符串)
- [匹配字符串](#匹配字符串) - [匹配字符串](#匹配字符串)
- [正则表达式](#正则表达式) - [Regular Expressions](#regular-expressions)
- [危险命令](#危险命令) - [危险命令](#危险命令)
- [脆弱命令](#脆弱命令) - [脆弱命令](#脆弱命令)
- [捕获异常](#捕获异常) - [捕获异常](#捕获异常)
@ -25,7 +25,7 @@ lang: cn
- [插件布局](#插件布局) - [插件布局](#插件布局)
- [功能](#功能) - [功能](#功能)
- [命令](#命令) - [命令](#命令)
- [自动命令](#autocommands) - [自动命令](#自动命令)
- [映射](#映射) - [映射](#映射)
- [错误](#错误) - [错误](#错误)
- [设置](#设置) - [设置](#设置)
@ -40,13 +40,13 @@ lang: cn
## Commit emoji 规范 ## Commit emoji 规范
- :memo: 添加一个备注或者文档 - `:memo:` 添加一个备注或者文档
- :gift: 新的特新 - `:gift:` 新的特新
- :bug: bug 修复 - `:bug:` bug 修复
- :bomb: 破坏向后兼容 - `:bomb:` 破坏向后兼容
- :white_check_mark: 添加测试 - `:white_check_mark:` 添加测试
- :fire: 移除某些配置 - `:fire:` 移除某些配置
- :beer: 代码优化 - `:beer:` 代码优化
## vim 脚本代码规范 ## vim 脚本代码规范

View File

@ -9,20 +9,20 @@ lang: cn
<!-- vim-markdown-toc GFM --> <!-- vim-markdown-toc GFM -->
- [寻求帮助](#寻求帮助) - [寻求帮助](#寻求帮助)
- [Reporting issues](#反馈错误) - [反馈问题](#反馈问题)
- [Contributing code](#contributing-code) - [贡献代码](#贡献代码)
- [License](#license) - [证书](#证书)
- [Conventions](#conventions) - [公约](#公约)
- [Pull Request](#pull-request) - [Pull Request](#pull-request)
- [Rebase your pr Branch on top of upstream master:](#rebase-your-pr-branch-on-top-of-upstream-master) - [在上游的主分支顶部压缩你的PR分支](#在上游的主分支顶部压缩你的pr分支)
- [Ideally for simple PRs (most of them):](#ideally-for-simple-prs-most-of-them) - [抽象化的简单 PRs(绝大多数PRs都是这样的):](#抽象化的简单-prs绝大多数prs都是这样的)
- [For complex PRs (big refactoring, etc):](#for-complex-prs-big-refactoring-etc) - [复杂的PRs (大的重构, 等):](#复杂的prs-大的重构-等)
- [Contributing a layer](#contributing-a-layer) - [Contributing a layer 贡献层](#contributing-a-layer-贡献层)
- [File header](#file-header) - [文件头](#文件头)
- [Author of a new layer](#author-of-a-new-layer) - [新layer的作者](#新layer的作者)
- [Contributor to an existing layer](#contributor-to-an-existing-layer) - [对现有的layer进行贡献](#对现有的layer进行贡献)
- [Contributing a keybinding](#contributing-a-keybinding) - [贡献按键绑定](#贡献按键绑定)
- [Language specified key bindings](#language-specified-key-bindings) - [特定语言的按键绑定](#特定语言的按键绑定)
- [Contributing a banner](#contributing-a-banner) - [Contributing a banner](#contributing-a-banner)
- [Build with SpaceVim](#build-with-spacevim) - [Build with SpaceVim](#build-with-spacevim)
- [Changelog](#changelog) - [Changelog](#changelog)
@ -38,9 +38,9 @@ SpaceVim 是每个志愿者的努力的结晶,我们鼓励你参与进来. Space
你可以只阅读下面内容中的,你需要用到的部分: 你可以只阅读下面内容中的,你需要用到的部分:
- [Asking for help](#寻求帮助) 建立issue的帮助 - [Asking for help](#寻求帮助) 建立issue的帮助
- [Reporting issues](#反馈错误) 反馈问题的帮助 - [Reporting issues](#反馈错误) 反馈问题的帮助
- [Contributing code](#贡献代码) 建立PR的帮助 - [Contributing code](#贡献代码) 建立PR的帮助
## 寻求帮助 ## 寻求帮助

View File

@ -39,13 +39,13 @@ description: "conventions of contributing to SpaceVim, including the coding styl
## Commit emoji convention ## Commit emoji convention
- :memo: Add comment or doc - `:memo:` Add comment or doc
- :gift: New feature. - `:gift:` New feature.
- :bug: Bug fix - `:bug:` Bug fix
- :bomb: Breaking compatibility. - `:bomb:` Breaking compatibility.
- :white_check_mark: Write test. - `:white_check_mark:` Write test.
- :fire: Remove something. - `:fire:` Remove something.
- :beer: I'm happy like reduced code complexity. - `:beer:` I'm happy like reduced code complexity.
## Viml coding style guide ## Viml coding style guide

View File

@ -664,13 +664,13 @@ The prefix can be `[SPC]`, `[Window]`, `[denite]`, `<leader>` and `[unite]`.
The default key of these prefix is: The default key of these prefix is:
| Prefix name | custom option and default value | description | | Prefix name | custom option and default value | description |
| ----------- | --------------------------------------------------------------------------- | ---------------------------------- | | ----------- | --------------------------------- | ----------------------------------- |
| `[SPC]` | NONE / `<Space>` | default mapping prefix of SpaceVim | | `[SPC]` | NONE / `<Space>` | default mapping prefix of SpaceVim |
| `[Window]` | `g:spacevim_windows_leader` / `s` | window mapping prefix of SpaceVim | | `[Window]` | `g:spacevim_windows_leader` / `s` | window mapping prefix of SpaceVim |
| `[denite]` | `g:spacevim_denite_leader` / `F` | denite mapping prefix of SpaceVim | | `[denite]` | `g:spacevim_denite_leader` / `F` | denite mapping prefix of SpaceVim |
| `[unite]` | `g:spacevim_unite_leader` / `f` | unite mapping prefix of SpaceVim | | `[unite]` | `g:spacevim_unite_leader` / `f` | unite mapping prefix of SpaceVim |
| `<leader>` | `mapleader` / `\` \| default leader prefix of vim/neovim | | | `<leader>` | `mapleader` / `` \ `` | default leader prefix of vim/neovim |
By default the guide buffer will be displayed 1000ms after the key has been pressed. You can change the delay by setting `'timeoutlen'` option to your liking (the value is in milliseconds). By default the guide buffer will be displayed 1000ms after the key has been pressed. You can change the delay by setting `'timeoutlen'` option to your liking (the value is in milliseconds).
@ -678,7 +678,9 @@ for example, after pressing `<Space>` in normal mode, you will see :
![mapping-guide](https://cloud.githubusercontent.com/assets/13142418/25778673/ae8c3168-3337-11e7-8536-ee78d59e5a9c.png) ![mapping-guide](https://cloud.githubusercontent.com/assets/13142418/25778673/ae8c3168-3337-11e7-8536-ee78d59e5a9c.png)
this guide show you all the available key bindings begin with `[SPC]`, you can type `b` for all the buffer mappings, `p` for project mappings, etc. after pressing `<C-h>` in guide buffer, you will get paging and help info in the statusline. this guide show you all the available key bindings begin with `[SPC]`, you can type `b` for all the buffer mappings, `p` for project mappings, etc.
after pressing `<C-h>` in guide buffer, you will get paging and help info in the statusline.
| key | description | | key | description |
| --- | ----------------------------- | | --- | ----------------------------- |
@ -1579,26 +1581,27 @@ Use `svc` to open a file in the existing Vim server, or using `nsvc` to open a f
![server-and-client](https://user-images.githubusercontent.com/13142418/32554968-7164fe9c-c4d6-11e7-95f7-f6a6ea75e05b.gif) ![server-and-client](https://user-images.githubusercontent.com/13142418/32554968-7164fe9c-c4d6-11e7-95f7-f6a6ea75e05b.gif)
<!-- SpaceVim Achievements start --> <!-- SpaceVim Achievements start -->
## Achievements ## Achievements
### issues ### issues
Achievements | Account | Achievements | Account |
----- | ----- | --------------------------------------------------------------------- | ------------------------------------------- |
[100th issue(issue)](https://github.com/SpaceVim/SpaceVim/issues/100) | [BenBergman](https://github.com/BenBergman) | [100th issue(issue)](https://github.com/SpaceVim/SpaceVim/issues/100) | [BenBergman](https://github.com/BenBergman) |
[1000th issue(PR)](https://github.com/SpaceVim/SpaceVim/issues/1000) | [sei40kr](https://github.com/sei40kr) | [1000th issue(PR)](https://github.com/SpaceVim/SpaceVim/issues/1000) | [sei40kr](https://github.com/sei40kr) |
### Stars, forks and watchers ### Stars, forks and watchers
Achievements | Account | Achievements | Account |
----- | ----- | ----------------- | ----------------------------------------------- |
First stargazers | [monkeydterry](https://github.com/monkeydterry) | First stargazers | [monkeydterry](https://github.com/monkeydterry) |
100th stargazers | [ShaneDelmore](https://github.com/ShaneDelmore) | 100th stargazers | [ShaneDelmore](https://github.com/ShaneDelmore) |
1000th stargazers | [dongkui0712](https://github.com/dongkui0712) | 1000th stargazers | [dongkui0712](https://github.com/dongkui0712) |
2000th stargazers | [EvgeneOskin](https://github.com/EvgeneOskin) | 2000th stargazers | [EvgeneOskin](https://github.com/EvgeneOskin) |
3000th stargazers | [zerdon](https://github.com/zerdon) | 3000th stargazers | [zerdon](https://github.com/zerdon) |
4000th stargazers | [sfwatergit](https://github.com/sfwatergit) | 4000th stargazers | [sfwatergit](https://github.com/sfwatergit) |
5000th stargazers | [robgrzel](https://github.com/robgrzel) | 5000th stargazers | [robgrzel](https://github.com/robgrzel) |
<!-- SpaceVim Achievements end --> <!-- SpaceVim Achievements end -->