diff --git a/docs/about.md b/docs/about.md index dbd5da123..9a9767458 100644 --- a/docs/about.md +++ b/docs/about.md @@ -1,3 +1,19 @@ ### About SpaceVim -SpaceVim is ... +[SpaceVim](https://github.com/SpaceVim/SpaceVim) is a Modular configuration, a bundle of custom settings and plugins for Vim, +here we call them 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. + +If you encounter any bugs or have feature requests, just open an issue +report on Github. + +For learning about Vim in general, read [vim-galore](https://github.com/mhinz/vim-galore). + +#### Credits & Thanks + +- [![GitHub contributors](https://img.shields.io/github/contributors/SpaceVim/SpaceVim.svg)](https://github.com/SpaceVim/SpaceVim/graphs/contributors) +- [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 diff --git a/docs/community.md b/docs/community.md index e4080d072..0aaa403ab 100644 --- a/docs/community.md +++ b/docs/community.md @@ -1,15 +1,17 @@ -#### Community +## Community Try these SpaceVim hangouts for any questions, problems or comments. -- Ask +### Ask - [issue tracker](https://github.com/SpaceVim/SpaceVim/issues) for issue and feature requests - vi StackExchange for "how to" & configuration questions - - [![Twitter Follow](https://img.shields.io/twitter/follow/SpaceVim.svg?style=social&label=Follow&maxAge=2592000)](https://twitter.com/SpaceVim) for hugs & pithy comments -- Chat + - [Twitter](https://twitter.com/SpaceVim) for hugs & pithy comments + +### Chat - [![Gitter](https://badges.gitter.im/SpaceVim/SpaceVim.svg)](https://gitter.im/SpaceVim/SpaceVim?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) - [![QQ](https://img.shields.io/badge/QQ群-121056965-blue.svg)](https://jq.qq.com/?_wv=1027&k=43DB6SG) - [![Facebook](https://img.shields.io/badge/FaceBook-SpaceVim-blue.svg)](https://www.facebook.com/SpaceVim) -- Discuss + +### Discuss To report an issue or give feedback to the developers, please use the [issue tracker](https://github.com/SpaceVim/SpaceVim/issues). diff --git a/docs/development.md b/docs/development.md index e69de29bb..de1a13bfb 100644 --- a/docs/development.md +++ b/docs/development.md @@ -0,0 +1,11 @@ +## Support SpaceVim + +### Development happens in the GitHub repository. + +[![Throughput Graph](https://graphs.waffle.io/SpaceVim/SpaceVim/throughput.svg)](https://github.com/SpaceVim/SpaceVim) + +#### Report bugs + +If you get any issues, please open an issue with the ISSUE_TEMPLATE. It is useful for me to debug for this issue. + +#### Contribute Layers diff --git a/docs/sponsors.md b/docs/sponsors.md index e69de29bb..c2fb8b8c7 100644 --- a/docs/sponsors.md +++ b/docs/sponsors.md @@ -0,0 +1,3 @@ +## Current Sponsors + +