aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorjdhao <jdhao@hotmail.com>2020-02-23 14:01:46 +0800
committerjdhao <jdhao@hotmail.com>2020-02-23 14:01:46 +0800
commit82502cb75f1aff620f4b384520957970b59a8a41 (patch)
tree008ce637540f86d438d3204fd7d56b580d53ac15 /README.md
parentb64a1991259517475b690a0c5570780dbdfa407d (diff)
Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files 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 @@
<p align="center">
-<img src="images/demo_look.jpg">
+<img src="images/demo_look.jpg" widht="600">
</p>
# 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, `<leader>` represents `,` character.
+
+| Shortcut | Description |
+|--------------|---------------------------------------------------------------|
+| `<leader>s` | Toggle the sidebar (show project tree view) |
+| `<leader>f` | Open file fuzzy search in floating window and starting search |
+| `<leader>s` | Remove trailing whitespaces |
+| `<leader>t` | Toggle tag window (show project tags in the right window) |
+| `<leader>v` | Reselect last pasted text |
+| `<leader>ev` | Edit Neovim config in a new tabpage |
+| `<leader>sv` | Reload Neovim config |
+| `<leader>q` | Quit current window |
+| `<leader>Q` | Quit all window and close Neovim |
+| `<leader>w` | Save current buffer content |
+
# Trouble shooting
If you come across an issue, you can first use `:checkhealth` command provided