diff options
| -rw-r--r-- | README.md | 12 | ||||
| -rw-r--r-- | docs/README.md | 12 | ||||
| -rw-r--r-- | tools/README.md | 4 |
3 files changed, 14 insertions, 14 deletions
@@ -5,18 +5,18 @@ # Introduction This is my Neovim configuration for all the platforms I use (Linux, Windows and -MacOS). `init.vim` is the config file for terminal Neovim, and `ginit.vim` is +macOS). `init.vim` is the config file for terminal Neovim, and `ginit.vim` is the additional config file for GUI client of Neovim (I am using [neovim-qt](https://github.com/equalsraf/neovim-qt) for now on Windows). My configurations are heavily documented to make it as clear as possible. While -you can download the whole repository and use it, it is not recommended to do -so. Good configurations are personal. Everyone should have his or her unique -config file. You are encouraged to copy from this this repo the part you feel -useful and add it to your own Nvim config. +you can download the whole repository and use it, it is not recommended though. +Good configurations are personal. Everyone should have his or her unique config +file. You are encouraged to copy from this this repo the part you feel useful +and add it to your own Nvim config. See [doc here](docs/README.md) on how to install Nvim's dependencies, Nvim -itself and the configuration on different platforms (Linux, MacOS and Windows). +itself and the configuration on different platforms (Linux, macOS and Windows). # Features # diff --git a/docs/README.md b/docs/README.md index ffbb16d..071c69e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -69,7 +69,7 @@ page](https://github.com/BurntSushi/ripgrep/releases) and install it. ## Linters -A linter is a tool to check the source code for possible style and syntatic +A linter is a tool to check the source code for possible style and syntax issues. Based on the programming languages we use, we may need to install various linters. @@ -126,7 +126,7 @@ The easiest way to install Neovim on Windows is via we can install neovim easily with ``` -# install latest version of neovim +# install the latest version of neovim # choco install neovim --pre choco install neovim @@ -139,13 +139,13 @@ from GitHub and manually extract it. ## Mac -It is recommended to install neovim via [Homebrew](https://brew.sh/) on MacOS. +It is recommended to install neovim via [Homebrew](https://brew.sh/) on macOS. Simply run the following command: ``` brew install neovim -# If you want to install latest version of neovim, use the following command -# instead. +# If you want to install the latest version of neovim, use the following +# command instead. # brew install --HEAD neovim ``` @@ -153,7 +153,7 @@ After installing Neovim, we need to add the directory where the Neovim executable (`nvim` on Linux and Mac, `nvim.exe` on Windows) resides to the system `PATH`. -Make sure that you can call `nvim` from the command line after all these setup. +Make sure that you can call `nvim` from the command line after all these setups. # Setting up Nvim diff --git a/tools/README.md b/tools/README.md index 8c7f928..d0fa2a2 100644 --- a/tools/README.md +++ b/tools/README.md @@ -1,2 +1,2 @@ -For the detail on how to set up `markdown2ctags.py` for showing Markdown tags in tagbar, -see [this post](https://jdhao.github.io/2019/10/15/tagbar_markdown_setup/). +For the detail on how to set up `markdown2ctags.py` to show Markdown tags +in tagbar, see [this post](https://jdhao.github.io/2019/10/15/tagbar_markdown_setup/). |