mirror of
https://github.com/SpaceVim/SpaceVim.git
synced 2025-02-03 00:20:05 +08:00
Move context from readme
This commit is contained in:
wsdjeg
parent
b0372e3f2b
commit
718b672387
179
README.md
179
README.md
@ -13,40 +13,6 @@
|
||||
[](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 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.
|
||||
|
||||
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)
|
||||
|
||||
# Table of Contents
|
||||
|
||||
|
||||
<!-- vim-markdown-toc GFM -->
|
||||
* [Introduction](#introduction)
|
||||
* [Features](#features)
|
||||
* [Mnemonic key bindings](#mnemonic-key-bindings)
|
||||
* [Unite work flow](#unite-work-flow)
|
||||
* [module statusline](#module-statusline)
|
||||
* [Install](#install)
|
||||
* [1. Requirements](#1-requirements)
|
||||
* [2. Install SpaceVim in Linux/Mac](#2-install-spacevim-in-linuxmac)
|
||||
* [3. Install SpaceVim in windows](#3-install-spacevim-in-windows)
|
||||
* [Update](#update)
|
||||
* [Documentation](#documentation)
|
||||
* [Quick start guide](#quick-start-guide)
|
||||
* [Community](#community)
|
||||
* [Support SpaceVim](#support-spacevim)
|
||||
* [contribute to SpaceVim](#contribute-to-spacevim)
|
||||
* [Write post about SpaceVim](#write-post-about-spacevim)
|
||||
* [Credits & Thanks](#credits--thanks)
|
||||
|
||||
<!-- vim-markdown-toc -->
|
||||
|
||||
## Introduction
|
||||
|
||||
[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
|
||||
to select the layers they need. It got inspired by [spacemacs](https://github.com/syl20bnr/spacemacs). If you use SpaceVim,
|
||||
@ -55,10 +21,6 @@ put more time into development.
|
||||
|
||||
|
||||
|
||||
If you are new to vim, you should learn about Vim in general, read [vim-galore](https://github.com/mhinz/vim-galore).
|
||||
|
||||
## Features
|
||||
|
||||
- **Great documentation:** access documentation in Vim with
|
||||
<kbd>:h SpaceVim</kbd>.
|
||||
- **Beautiful GUI:** you'll love the awesome UI and its useful features.
|
||||
@ -71,59 +33,15 @@ If you are new to vim, you should learn about Vim in general, read [vim-galore](
|
||||
[conventions](http://spacevim.org/development/).
|
||||
- **Neovim centric:** Dark powered mode of SpaceVim
|
||||
|
||||
### Mnemonic key bindings
|
||||
See the [documentation](https://spacevim.org/documentation) or [the list of layers](http://spacevim.org/layers/) for more information.
|
||||
|
||||
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).
|
||||
Here is a throughput graph of the repository for the last few weeks:
|
||||
|
||||
for example, after pressing `<Space>` in normal mode, you will see :
|
||||
[](https://waffle.io/SpaceVim/SpaceVim/metrics/throughput)
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
here is the guide for the default mappings in SpaceVim:
|
||||
|
||||
|
||||
|
||||
### Unite work flow
|
||||
|
||||
|
||||
|
||||
### module statusline
|
||||
|
||||
The `core#statusline` layer provide a heavily customized powerline with the following capabilities:, It is inspired by spacemacs's mode-line. and this layer is loaded by default.
|
||||
|
||||
- show the window number
|
||||
- color code for current state
|
||||
- show the number of search results
|
||||
- toggle syntax checking info
|
||||
- toggle battery info
|
||||
- toggle minor mode lighters
|
||||
|
||||
|
||||
|
||||
## Install
|
||||
|
||||
### 1. Requirements
|
||||
|
||||
**nerd fonts and true colors:**
|
||||
|
||||
SpaceVim provides basic and awesome mode, if you want to use awesome mode, you need to install the [nerd-fonts](https://github.com/ryanoasis/nerd-fonts) and make sure your terminal support [true colors](https://gist.github.com/XVilka/8346728).
|
||||
|
||||
**Vim 7.4 above or neovim:**
|
||||
|
||||
- [neovim installation](https://github.com/neovim/neovim/wiki/Installing-Neovim)
|
||||
|
||||
- [install vim with python, python3 and lua support](https://github.com/Valloric/YouCompleteMe/wiki/Building-Vim-from-source)
|
||||
|
||||
**git:**
|
||||
|
||||
SpaceVim will download all plugins via git.
|
||||
|
||||
### 2. Install SpaceVim in Linux/Mac
|
||||
|
||||
Install SpaceVim with the command below:
|
||||
|
||||
```bash
|
||||
curl -sLf https://spacevim.org/install.sh | bash
|
||||
```
|
||||
@ -136,93 +54,7 @@ for more info about the install script, please check:
|
||||
curl -sLf https://spacevim.org/install.sh | bash -s -- -h
|
||||
```
|
||||
|
||||
### 3. Install SpaceVim in windows
|
||||
|
||||
- For vim in windows, please just clone this repo as vimfiles in you Home directory.
|
||||
by default, when open a cmd, the current dir is your Home directory, run this command in cmd.
|
||||
make sure you have a backup of your own vimfiles. also you need remove `~/_vimrc` in your home directory.
|
||||
|
||||
```sh
|
||||
git clone https://github.com/SpaceVim/SpaceVim.git vimfiles
|
||||
```
|
||||
|
||||
- For neovim in windows, please clone this repo as `AppData\Local\nvim` in your home directory.
|
||||
for more info, please check out [neovim's wiki](https://github.com/neovim/neovim/wiki/Installing-Neovim).
|
||||
by default, when open a cmd, the current dir is your Home directory, run this command in cmd.
|
||||
|
||||
```bash
|
||||
git clone https://github.com/SpaceVim/SpaceVim.git AppData\Local\nvim
|
||||
```
|
||||
|
||||
## Update
|
||||
|
||||
you can update SpaceVim with the command below:
|
||||
|
||||
```viml
|
||||
:SPUpdate SpaceVim
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
### Quick start guide
|
||||
|
||||
SpaceVim load custom configuration from `~/.SpaceVim.d/init.vim`,
|
||||
|
||||
:warning: It is not `~/.SpaceVim/init.vim`, user should not change anything in `~/.SpaceVim/`.
|
||||
|
||||
here is an example:
|
||||
|
||||
```vim
|
||||
" Here are some basic customizations, please refer to the ~/.SpaceVim.d/init.vim
|
||||
" file for all possible options:
|
||||
let g:spacevim_default_indent = 3
|
||||
let g:spacevim_max_column = 80
|
||||
|
||||
" Change the default directory where all miscellaneous persistent files go.
|
||||
" By default it is ~/.cache/vimfiles/.
|
||||
let g:spacevim_plugin_bundle_dir = '~/.cache/vimfiles/'
|
||||
|
||||
" set SpaceVim colorscheme
|
||||
let g:spacevim_colorscheme = 'gruvbox'
|
||||
|
||||
" Set plugin manager, you want to use, default is dein.vim
|
||||
let g:spacevim_plugin_manager = 'dein' " neobundle or dein or vim-plug
|
||||
|
||||
" Set windows shortcut leader [Window], default is `s`
|
||||
let g:spacevim_windows_leader = 's'
|
||||
|
||||
" Set unite work flow shortcut leader [Unite], default is `f`
|
||||
let g:spacevim_unite_leader = 'f'
|
||||
|
||||
" Set Denite work flow shortcut leader [Denite], default is `F`
|
||||
let g:spacevim_denite_leader = 'F'
|
||||
|
||||
" By default, language specific plugins are not loaded. This can be changed
|
||||
" with the following, then the plugins for go development will be loaded.
|
||||
call SpaceVim#layers#load('lang#go')
|
||||
|
||||
" loaded ui layer
|
||||
call SpaceVim#layers#load('ui')
|
||||
|
||||
" If there is a particular plugin you don't like, you can define this
|
||||
" variable to disable them entirely:
|
||||
let g:spacevim_disabled_plugins=[
|
||||
\ ['junegunn/fzf.vim'],
|
||||
\ ]
|
||||
|
||||
" If you want to add some custom plugins, use these options:
|
||||
let g:spacevim_custom_plugins = [
|
||||
\ ['plasticboy/vim-markdown', {'on_ft' : 'markdown'}],
|
||||
\ ['wsdjeg/GitHub.vim'],
|
||||
\ ]
|
||||
|
||||
" set the guifont
|
||||
let g:spacevim_guifont = 'DejaVu\ Sans\ Mono\ for\ Powerline\ 11'
|
||||
```
|
||||
|
||||
Comprehensive documentation is available for each layer by <kbd>:h SpaceVim</kbd>.
|
||||
|
||||
You can also check the [general documentation](http://spacevim.org/documentation/).
|
||||
|
||||
## Community
|
||||
|
||||
@ -261,11 +93,6 @@ markdown
|
||||
|
||||
Before contributing be sure to consult the [contribution guidelines](http://spacevim.org/development/#contribution-guidelines) and [conventions](http://spacevim.org/development/#conventions).
|
||||
|
||||
### Write post about SpaceVim
|
||||
|
||||
if you want to write something about SpaceVim, and want your post to be posted in [SpaceVim's blog page](https://spacevim.org/blog), please show us the link.
|
||||
|
||||
|
||||
## Credits & Thanks
|
||||
|
||||
- [](https://github.com/SpaceVim/SpaceVim/graphs/contributors)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user