From 0ecc2a2a8e664715faca98ab6e48be40ebce6a7c Mon Sep 17 00:00:00 2001 From: wsdjeg Date: Tue, 20 Feb 2018 22:02:00 +0800 Subject: [PATCH] Update guide ref: https://github.com/SpaceVim/SpaceVim/issues/1390 Update readme Update readme Fix guide --- README.cn.md | 9 ++------- README.md | 27 +++++++++++++-------------- docs/cn/quick-start-guide.md | 12 ++++++++++++ docs/quick-start-guide.md | 24 +++++++++++++++++------- 4 files changed, 44 insertions(+), 28 deletions(-) diff --git a/README.cn.md b/README.cn.md index b2b35c554..b11a1f633 100644 --- a/README.cn.md +++ b/README.cn.md @@ -11,15 +11,10 @@ [![GitHub forks](https://img.shields.io/github/forks/SpaceVim/SpaceVim.svg?style=social&label=Fork)](https://github.com/SpaceVim/SpaceVim) [![Twitter Follow](https://img.shields.io/twitter/follow/SpaceVim.svg?style=social&label=Follow&maxAge=2592000)](https://twitter.com/SpaceVim) +SpaceVim 是一个社区驱动的模块化 vim 配置，以模块的方式组织和管理插件，提供各种类似 IDE 的特性。 + ![welcome-page](https://cloud.githubusercontent.com/assets/13142418/26402270/28ad72b8-40bc-11e7-945e-003f41e057be.png) -项 目 主 页： - -码 云 地 址： - -SpaceVim 是一个社区驱动的模块化 vim/neovim 配置集合，其中包含了多种功能模块，并且针对 neovim 做了功能优化。spacevim 有多种功能模块可供用户选择，针对不同语言选择特定的模块，就可以配置出一个适合特定语言开发的环境。 - -使用过程中遇到问题或者有什么功能需求可以[提交issue](https://gitee.com/spacevim/SpaceVim/issues/new)，这将帮助我们一起提升产品。我们也欢迎喜欢 vim/neovim 的用户加入我们的 QQ 群，一起讨论 vim 相关的技巧，[点击加入Vim/SpaceVim用户群](https://jq.qq.com/?_wv=1027&k=43zWPlT)。 以下是近几周的开发汇总： diff --git a/README.md b/README.md index 0056ea620..4156d786a 100644 --- a/README.md +++ b/README.md @@ -16,10 +16,9 @@ [![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") -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 -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 community-driven modular vim distribution. It manages collections +of plugins in layers, which help collect related packages together to provide IDE-like features. +SpaceVim is not only a vimrc but an ultimate Vim configuration, It contains many build-in features. ![welcome-page](https://user-images.githubusercontent.com/13142418/33793078-3446cb6e-dc76-11e7-9998-376a355557a4.png) @@ -32,17 +31,17 @@ Here is a throughput graph of the repository for the last few weeks: -- [Features](#features) +- [New Features](#new-features) - [Install](#install) - - [Linux and macOS](#linux-and-macos) - - [Windows](#windows) - [Project layout](#project-layout) - [Support SpaceVim](#support-spacevim) - [Credits & Thanks](#credits--thanks) -## Features +### New Features + +This is a list of latest features implemented in SpaceVim: **Highlight cursor symbol** @@ -80,11 +79,11 @@ create an UI for [dein.vim](https://github.com/Shougo/dein.vim/) - the best asyn For more features, please read [SpaceVim's Blog](https://spacevim.org/blog/) -## Install +### 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). -### Linux and macOS +**Linux and macOS** ```bash curl -sLf https://spacevim.org/install.sh | bash @@ -98,11 +97,11 @@ For more info about the install script, please check: 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. -## Project layout +### Project layout ```txt ├─ autoload/SpaceVim/api/ APIs @@ -117,7 +116,7 @@ The easist way is to download [install.cmd](https://spacevim.org/install.cmd) an ``` -## Support SpaceVim +### 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. @@ -133,7 +132,7 @@ clicking following icon. Bitcoin: 1DtuVeg81c2L9NEhDaVTAAbrCR3pN5xPFv -## Credits & Thanks +### Credits & Thanks - [![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) diff --git a/docs/cn/quick-start-guide.md b/docs/cn/quick-start-guide.md index 0c028603b..00bb5e4ad 100644 --- a/docs/cn/quick-start-guide.md +++ b/docs/cn/quick-start-guide.md @@ -13,6 +13,10 @@ lang: cn - [安装](#安装) - [Linux 或 macOS](#linux-或-macos) - [Windows](#windows) +- [基本使用](#基本使用) + - [模块及插件管理](#模块及插件管理) + - [常用快捷键](#常用快捷键) + - [IDE-like 特性](#ide-like-特性) @@ -41,3 +45,11 @@ curl -sLf https://spacevim.org/cn/install.sh | bash -s -- -h ### Windows window 下最快捷的安装方法是下载安装脚本 [install.cmd](https://spacevim.org/cn/install.cmd) 并运行。 + +## 基本使用 + +### 模块及插件管理 + +### 常用快捷键 + +### IDE-like 特性 diff --git a/docs/quick-start-guide.md b/docs/quick-start-guide.md index 4fd286e02..6cbd966d0 100644 --- a/docs/quick-start-guide.md +++ b/docs/quick-start-guide.md @@ -6,24 +6,27 @@ description: "SpaceVim is a community-driven vim distribution that seeks to prov # Quick start guide +If you haven’t seen SpaceVim at all yet, the first thing you should read is The Quick start guide. +It will give you a good idea of what SpaceVim is like, +show you how to install it, and explain its features. + +Upon completing the book, you’ll be an intermediate Rust developer, and will have a good grasp of the fundamental ideas behind Rust. + -- [Requirements](#requirements) - [Install](#install) - [Linux and macOS](#linux-and-macos) - [Windows](#windows) +- [Learning SpaceVim](#learning-spacevim) -## Requirements +## Install -At a minimum, SpaceVim requires `git` and `wget` to be installed. These tools +At a minimum, SpaceVim requires `git` and `curl` to be installed. These tools are needed for downloading plugins and fonts. -If you are new to vim, you should learning about Vim in general, read -[vim-galore](https://github.com/mhinz/vim-galore). - -## Install +If you are using vim/neovim in terminal, you also need to set the font of your terminal. ### Linux and macOS @@ -42,3 +45,10 @@ curl -sLf https://spacevim.org/install.sh | bash -s -- -h ### Windows The easist way is to download [install.cmd](https://spacevim.org/install.cmd) and run it as administrator, or install SpaceVim manually. + + +## Learning SpaceVim + +- [SpaceVim Documentation](documentation/). Also known as "The Book", The SpaceVim Documentation will introduce +you to the main topics important to using SpaceVim. The book is the primary official document of the language. +- [Hack-SpaceVim](https://github.com/Gabirel/Hack-SpaceVim). Tell you how to hack SpaceVim.