From a74dbe8f871372fb5ca457dbeaaaf5fba7b80631 Mon Sep 17 00:00:00 2001 From: Oliver Ladner Date: Thu, 23 Nov 2023 09:12:39 +0100 Subject: [PATCH] add more keymap info to README --- README.md | 31 +++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index b1f0419..220ae06 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ After doing my first steps with , I decided to roll my own, custom, "lightweight" Neovim configuration in order to better understand Neovim and its configuration/customization, package managers, -LSP etc. and have "my own" config that only includes things I really need. +plugins etc. and have "my own" config that only includes things I really need. ## Installation @@ -13,11 +13,13 @@ LSP etc. and have "my own" config that only includes things I really need. 1. Install OS dependencies documented in `init.lua` 1. Clone this Git repository to `~/.config/nvim` - ### Finishing touches -- Install Treesitter comment parser (to highlight `FIXME:/NOTE:/TODO:/XXX:`) with `:TSInstall comment` -- Create a `$HOME/.ignore` file and add big, useless directories to it, so Telescope/ripgrep/fd can ignore those. Details in `lua/weeheavy/plugins/telescope-fzf-native.lua` +- Install Treesitter comment parser (to highlight `FIXME:/NOTE:/TODO:/XXX:`) + with `:TSInstall comment` +- Create a `$HOME/.ignore` file and add big, useless directories to it, so + Telescope/ripgrep/fd can ignore those. A current list of files/directories is + in `lua/weeheavy/plugins/telescope-fzf-native.lua` ## Speed @@ -55,21 +57,23 @@ This is more accurate than `nvim --startuptime`. #### Basics -- `Space` is the leader key and shows key combinations thanks to `which-key.nvim` +- `Space` is set as the leader key #### Plugin fiddling/changes - `:so` Source file -- `:checkhealth ` check for problems with plugin. Use `:checkhealth` to check base and all plugins +- `:checkhealth ` check for problems of a plugin. Use `:checkhealth` + to check base and all plugins #### Navigation -- `Ctrl+t` to open a file in e.g. a Telescope finder in a new buffer -- `gt` or `gT` to navigate open buffers +- `Ctrl+t` to open a file in e.g. a Telescope finder in a new tab +- `gt` or `gT` to switch between open tabs - `Ctrl+wq` close window - `Ctrl+ws` split window horizontally - `Ctrl+wv` split window vertically - `Ctrl+` switch between split windows +- `Space+Space` shows open buffers (via `Telescope buffers`) ### Lazy @@ -77,12 +81,13 @@ This is more accurate than `nvim --startuptime`. ### Telescope -#### Telescope file search +#### Navigation in live_grep, find_files, git_status and file_browser -- `Ctrl+n` scroll down (**n**ext) file list -- `Ctrl+p` scroll up (**p**revious) file list +- `↓` or `Ctrl+n` scroll down (**n**ext) file list +- `↑` or `Ctrl+p` scroll up (**p**revious) file list - `Ctrl+d` scroll **d**own in preview - `Ctrl+u` scroll **u**p in preview +- `Ctrl+/` help ### Treesitter @@ -91,8 +96,6 @@ This is more accurate than `nvim --startuptime`. ## Open issues/TODOs -- Git handling in general -- Directory browsing with Telescope -- Solution to show short Git logs (potentially without fugitive) - Hinting for trailing spaces (EOL) and blank space on line - LSP setup/config (mason?), consume +- ollama integration