From b34b2e4e04384d34e582e5fab343a7558d5cd882 Mon Sep 17 00:00:00 2001 From: Wang Shidong Date: Sat, 22 Oct 2022 22:00:45 +0800 Subject: [PATCH] docs(readme): update readme --- README.md | 46 +++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 41 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 07cd9c4c9..2642d1a4d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- - SpaceVim + + SpaceVim

@@ -14,8 +14,6 @@ [![GPLv3 License](https://img.shields.io/badge/license-GPLv3-blue.svg)](https://github.com/SpaceVim/SpaceVim/blob/master/LICENSE) [![Docker Pulls](https://img.shields.io/docker/pulls/spacevim/spacevim)](https://hub.docker.com/r/spacevim/spacevim) -![welcome page](https://user-images.githubusercontent.com/13142418/176910121-8e7ca78f-8434-4ac7-9b02-08c4d15f8ad9.png) - [SpaceVim](https://spacevim.org/) is a vim configuration inspired by [spacemacs](https://github.com/syl20bnr/spacemacs), it is compatible with [Vim](https://github.com/vim/vim) and [Neovim](https://github.com/neovim/neovim). - [Documentation](https://spacevim.org/documentation/): the primary official documentation of SpaceVim @@ -23,6 +21,44 @@ The latest release [v2.0.0](https://spacevim.org/SpaceVim-release-v2.0.0/) was released at 2022-07-02, check out [following-HEAD](https://github.com/SpaceVim/SpaceVim/wiki/Following-HEAD) page for what happened since last release. +## Features + +- **Modularization**: Plugins and functions are organized in layer. +- **Compatible api**: A series of [compatible APIs](https://spacevim.org/api/) for Vim/Neovim. +- **Great documentation:** access documentation in SpaceVim with `:h SpaceVim`. +- **Beautiful UI:** you'll love the awesome UI and its useful features. +- **Mnemonic key bindings:** key binding guide will be displayed automatically +- **Fast boot time:** Lazy-load 90% of plugins with [dein.vim](https://github.com/Shougo/dein.vim) +- **Lower the risk of RSI:** by heavily using the space bar instead of modifiers. +- **Consistent experience:** consistent experience between terminal and gui + +## Screenshots + +![welcome page](https://user-images.githubusercontent.com/13142418/176910121-8e7ca78f-8434-4ac7-9b02-08c4d15f8ad9.png) + +## Project Layout + +```txt +├─ .ci/ build automation +├─ .github/ issue/PR templates +├─ .SpaceVim.d/ project specific configuration +├─ after/ overrule or add to the distributed defaults +├─ autoload/SpaceVim.vim SpaceVim core file +├─ autoload/SpaceVim/api/ Public APIs +├─ autoload/SpaceVim/layers/ available layers +├─ autoload/SpaceVim/plugins/ buildin plugins +├─ autoload/SpaceVim/mapping/ mapping guide +├─ colors/ default colorscheme +├─ docker/ docker image generator +├─ bundle/ bundle plugins +├─ lua/spacevim/plugin buildin plugins(lua) +├─ doc/ help(cn/en) +├─ docs/ website(cn/en) +├─ wiki/ wiki(cn/en) +├─ bin/ executable +└─ test/ tests +``` + ## Contribute This project wouldn't exist without all the people who [contributed](CONTRIBUTING.md), @@ -30,7 +66,7 @@ We are thankful for any contributions from the community. -## Credits & Thanks +## Credits - [Hack-SpaceVim](https://github.com/Gabirel/Hack-SpaceVim) by [@Gabirel](https://github.com/Gabirel) - [SpaceVimTutorial](https://everettjf.gitbooks.io/spacevimtutorial/content/) by [@everettjf](https://github.com/everettjf)