better docs

README.md

@@ -2,7 +2,6 @@
 
 [Insipiration](https://github.com/Racle/dotfiles/tree/master)
 
-
 # Usage
 
 Run `make stow`

nvim/.config/nvim/README.md

@@ -6,31 +6,7 @@ Inspirations:
 
 # Neovim Notes
 
-## Splits
-
-Horizontal split:
-
-```vim
-:sp
-```
-
-Vertical split:
-
-```vim
-:vs
-```
-
-Open a file in a horizontal split:
-
-```vim
-:sp path/to/file
-```
-
-Open a file in a vertical split:
-
-```vim
-:vs path/to/file
-```
+See custom keymaps with short descriptions with `<leader><leader>h`.
 
 Split shortcuts:
 
@@ -53,12 +29,6 @@ Buffer shortcuts:
 - `<leader>bn` next buffer
 - `<leader>bd` delete the current buffer
 
-Browse files with:
-
-```vim
-<leader>dl
-```
-
 Telescope shortcuts:
 
 - `<leader>ff` find files
@@ -68,22 +38,13 @@ Telescope shortcuts:
 
 Oil usage:
 
-- `<leader>dl` opens the parent directory of the current file
+- `<leader>dl` opens the file browser
 - `<CR>` opens a file or enters a directory
 - `-` goes to the parent directory
 - `<BS>` also goes to the parent directory
 - `<A-h>` also goes to the parent directory
 - `<A-l>` opens the selected file or enters the selected directory
-- `<C-p>` previews the selected entry in a right-hand vertical split
-- edit the Oil buffer, then `:w` to apply file operations
-- hidden files are shown, but `.git` stays hidden
-
-Open `netrw` explicitly with:
-
-```vim
-<leader>nl
-:Ex
-```
+- `<C-p>` previews the selected entry
 
 ## Window Navigation
 
@@ -104,31 +65,12 @@ Cycle through windows:
 
 ## Terminal
 
-Open a terminal in the current window:
-
-```vim
-:term
-```
-
-Open a terminal in a horizontal split:
-
-```vim
-:sp | term
-```
-
-Open a terminal in a vertical split:
-
-```vim
-:vs | term
-```
-
 Leave terminal mode and return to normal mode:
 
 ```vim
 <Esc>
 ```
 
-
 ## LSP
 
 When an LSP server is attached to the current buffer:
@@ -143,22 +85,15 @@ Diagnostics:
 
 - `g.` open diagnostic float
 - `gl` send diagnostics to the location list
+- `gle` display error information
+- `gie` toggle inline errors
+- `gve` toggle virtual line errors
 - `g]` jump to next error
 - `g[` jump to previous error
 
-
 ## Tree-sitter
 
-Tree-sitter is managed with `nvim-treesitter` via `vim.pack`.
-
-Installing missing parsers requires the external tools from the upstream README:
-
-- `tar`
-- `curl`
-- `tree-sitter-cli`
-- a C compiler
-
-If `tree-sitter` is on your `PATH`, startup will try to install the configured parsers if they are missing.
+Tree-sitter is managed with `nvim-treesitter` via `vim.pack`. `tree-sitter-cli` and a C compiler is required to be installed.
 
 Useful commands:
 

nvim/.config/nvim/lua/romanzy/remap.lua

@@ -19,6 +19,7 @@ local function telescope_picker(picker)
 end
 
 map("n", "<leader><leader>r", ":source ~/.config/nvim/init.lua<CR>", { desc = "reload init.lua" })
+map("n", "<leader><leader>h", telescope_picker("keymaps"), { desc = "show keymaps" })
 map("n", "<leader>dl", "<Cmd>Oil<CR>", { desc = "open oil" })
 map("n", "<leader>ff", telescope_picker("find_files"), { desc = "find files" })
 map("n", "<leader>fg", telescope_picker("live_grep"), { desc = "live grep" })