cleanup README
This commit is contained in:
@@ -2,7 +2,6 @@
|
|||||||
|
|
||||||
[Insipiration](https://github.com/Racle/dotfiles/tree/master)
|
[Insipiration](https://github.com/Racle/dotfiles/tree/master)
|
||||||
|
|
||||||
|
|
||||||
# Usage
|
# Usage
|
||||||
|
|
||||||
Run `make stow`
|
Run `make stow`
|
||||||
|
|||||||
@@ -6,32 +6,6 @@ Inspirations:
|
|||||||
|
|
||||||
# Neovim Notes
|
# 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
|
|
||||||
```
|
|
||||||
|
|
||||||
Split shortcuts:
|
Split shortcuts:
|
||||||
|
|
||||||
- `<leader>sv` open a vertical split
|
- `<leader>sv` open a vertical split
|
||||||
@@ -53,12 +27,6 @@ Buffer shortcuts:
|
|||||||
- `<leader>bn` next buffer
|
- `<leader>bn` next buffer
|
||||||
- `<leader>bd` delete the current buffer
|
- `<leader>bd` delete the current buffer
|
||||||
|
|
||||||
Browse files with:
|
|
||||||
|
|
||||||
```vim
|
|
||||||
<leader>dl
|
|
||||||
```
|
|
||||||
|
|
||||||
Telescope shortcuts:
|
Telescope shortcuts:
|
||||||
|
|
||||||
- `<leader>ff` find files
|
- `<leader>ff` find files
|
||||||
@@ -68,22 +36,13 @@ Telescope shortcuts:
|
|||||||
|
|
||||||
Oil usage:
|
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
|
- `<CR>` opens a file or enters a directory
|
||||||
- `-` goes to the parent directory
|
- `-` goes to the parent directory
|
||||||
- `<BS>` also goes to the parent directory
|
- `<BS>` also goes to the parent directory
|
||||||
- `<A-h>` 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
|
- `<A-l>` opens the selected file or enters the selected directory
|
||||||
- `<C-p>` previews the selected entry in a right-hand vertical split
|
- `<C-p>` previews the selected entry
|
||||||
- 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
|
|
||||||
```
|
|
||||||
|
|
||||||
## Window Navigation
|
## Window Navigation
|
||||||
|
|
||||||
@@ -104,31 +63,12 @@ Cycle through windows:
|
|||||||
|
|
||||||
## Terminal
|
## 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:
|
Leave terminal mode and return to normal mode:
|
||||||
|
|
||||||
```vim
|
```vim
|
||||||
<Esc>
|
<Esc>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## LSP
|
## LSP
|
||||||
|
|
||||||
When an LSP server is attached to the current buffer:
|
When an LSP server is attached to the current buffer:
|
||||||
@@ -143,22 +83,15 @@ Diagnostics:
|
|||||||
|
|
||||||
- `g.` open diagnostic float
|
- `g.` open diagnostic float
|
||||||
- `gl` send diagnostics to the location list
|
- `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 next error
|
||||||
- `g[` jump to previous error
|
- `g[` jump to previous error
|
||||||
|
|
||||||
|
|
||||||
## Tree-sitter
|
## Tree-sitter
|
||||||
|
|
||||||
Tree-sitter is managed with `nvim-treesitter` via `vim.pack`.
|
Tree-sitter is managed with `nvim-treesitter` via `vim.pack`. `tree-sitter-cli` and a C compiler is required to be installed.
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
Useful commands:
|
Useful commands:
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user