From 82502cb75f1aff620f4b384520957970b59a8a41 Mon Sep 17 00:00:00 2001 From: jdhao Date: Sun, 23 Feb 2020 14:01:46 +0800 Subject: [PATCH] Update README --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b8e0cbc..e59f45f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- +

# Introduction @@ -18,7 +18,7 @@ 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). -## Features ## +# Features # + Auto-completion for Python via [Deoplete](https://github.com/Shougo/deoplete.nvim). + Source code linting via [Neomake](https://github.com/neomake/neomake). @@ -33,6 +33,23 @@ itself and the configuration on different platforms (Linux, MacOS and Windows). + Tags navigation via [tagbar](https://github.com/majutsushi/tagbar). + ...... +# Shortcuts + +In the following shortcuts, `` represents `,` character. + +| Shortcut | Description | +|--------------|---------------------------------------------------------------| +| `s` | Toggle the sidebar (show project tree view) | +| `f` | Open file fuzzy search in floating window and starting search | +| `s` | Remove trailing whitespaces | +| `t` | Toggle tag window (show project tags in the right window) | +| `v` | Reselect last pasted text | +| `ev` | Edit Neovim config in a new tabpage | +| `sv` | Reload Neovim config | +| `q` | Quit current window | +| `Q` | Quit all window and close Neovim | +| `w` | Save current buffer content | + # Trouble shooting If you come across an issue, you can first use `:checkhealth` command provided