From 5f801534fc2c578e5cb47aa497e000e9557282f1 Mon Sep 17 00:00:00 2001 From: wsdjeg Date: Sun, 10 Dec 2017 19:50:06 +0800 Subject: [PATCH] Update wiki --- wiki/Development-tips.md | 9 +++++++++ wiki/Introduction.md | 14 ++++++-------- wiki/project_layout.md | 13 +++++++++++++ 3 files changed, 28 insertions(+), 8 deletions(-) create mode 100644 wiki/Development-tips.md diff --git a/wiki/Development-tips.md b/wiki/Development-tips.md new file mode 100644 index 000000000..80f4a4226 --- /dev/null +++ b/wiki/Development-tips.md @@ -0,0 +1,9 @@ +steps of sending a PR: + +1. fork this repo +2. checkout new branch from dev branch +3. push your commits +4. sending pull request + + + diff --git a/wiki/Introduction.md b/wiki/Introduction.md index a6ea2ec09..99ed39a8a 100644 --- a/wiki/Introduction.md +++ b/wiki/Introduction.md @@ -1,11 +1,9 @@ -## Introduction +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. -[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, -please star it on github. It's a great way of getting feedback and gives me the kick to -put more time into development. +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! -![2017-02-26_1365x739](https://cloud.githubusercontent.com/assets/13142418/23339920/590f2e9a-fc67-11e6-99ec-794f79ba0902.png) +![welcome-page](https://user-images.githubusercontent.com/13142418/33793078-3446cb6e-dc76-11e7-9998-376a355557a4.png) -If you are new to vim, you should learning about Vim in general, read [vim-galore](https://github.com/mhinz/vim-galore). \ No newline at end of file +See the [documentation](https://spacevim.org/documentation) or [the list of layers](http://spacevim.org/layers/) for more information. + +If you are new to vim, you should learning about Vim in general, read [vim-galore](https://github.com/mhinz/vim-galore). diff --git a/wiki/project_layout.md b/wiki/project_layout.md index a4adf03e2..c5f779ae4 100644 --- a/wiki/project_layout.md +++ b/wiki/project_layout.md @@ -9,3 +9,16 @@ This is the project layout of SpaceVim org: | [SpaceVim/vim-swig](https://github.com/SpaceVim/vim-swig) | Swig vim syntax highlighting | | [SpaceVim/vim-luacomplete](https://github.com/SpaceVim/vim-luacomplete) | lua complete plugin for vim | | [SpaceVim/unite-unicode](https://github.com/SpaceVim/unite-unicode) | Unite.vim plugin to insert unicode gyphs | + +In the main repo, the layout is: + + ├─ 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 +