add readme with info about configs. #1

Merged
voronind merged 3 commits from readme into master 2023-10-21 21:38:38 +03:00
Showing only changes of commit b6d5e55e77 - Show all commits

View file

@ -7,6 +7,7 @@ This is my own custom config that I use on my GNU/Linux machines. Not ment to be
2. [Load Gnome settings.](#load-gnome-settings)
3. [Navigation.](#navigation)
4. [Bash commands.](#bash-commands)
5. [Nvim config.](#nvim-config)
# General info.
@ -96,9 +97,18 @@ Key|Action
`Space+v`|Visual selection.
`Space+f`|None.
### Nvim extra keys.
More info in [Nvim config.](#nvim-config)
#### Common. TODO: separate visual and others from common.
# Nvim config. TODO: preserve default shortcuts, only add new ones when adding new functionality.
## General info.
* Run `:Update` to update everything.
* File tree shows everything by default, telescope ingores git-ignored files.
## Keymaps.
### Common. TODO: separate visual and others from common.
Mode|Key|Action
---|---|---
@ -106,7 +116,7 @@ Normal, Visual|`5dd`|Repeat following command N (5) times.
Normal|`.`|Repeat input on selected line.
Normal, Visual|`<Leader>.`|Repeat command on selected line(s).
Normal|`zz`|Save all files.
Normal|`ZZ`, `<Space>z`|Save and quit.
Normal|`ZZ`, `<Space>z`|Save all and quit.
Normal|`ZQ`|Quit without saving.
Normal|`v`, `<Space>v`|Visual selection (cursor).
Normal|`V`|Visual selection (lines).
@ -123,27 +133,27 @@ Visual|`~`|Toggle case.
Normal, Visual|`;`|Enter command mode (*default*: `:`).
Normal|`<Space>0`|Open shortcuts help.
#### Align.
### Align.
Mode|Key|Action
---|---|---
Visual|`<Space>A`|Align selection from the right.
Visual|`<Space>a`|Align selection from the left.
#### Autocomplete.
### Autocomplete.
Mode|Key|Action
---|---|---
Input|`<C-Space>`|Autocomplete.
Normal|`<C-Space>`|LSP autocomplete.
#### Comments.
### Comments.
Mode|Key|Action
---|---|---
Normal, Visual|`<Space>/`|Toggle selected line(s) comment.
#### File tree.
### File tree.
Mode|Key|Action
---|---|---
@ -163,20 +173,20 @@ Normal|`I`|Toggle gitignore filter.
Normal|`y`|Copy name.
Normal|`Y`|Copy relative path.
#### Fold.
### Fold.
Mode|Key|Action
---|---|---
Normal|`<Space>o`|Toggle fold.
Normal|`<Space>O`|Fold everything.
#### Git.
### Git.
Mode|Key|Action
---|---|---
Normal|`<Space>g`|Toggle git inspection mode.
#### Macros.
### Macros.
Mode|Key|Action
---|---|---
@ -202,7 +212,7 @@ Visual|`mmc`|Markdown: make selection a code block.
Normal|`mi`|Copy and increment selected line.
Normal|`ma`|Select all.
#### Navigation.
### Navigation.
Mode|Key|Action
---|---|---
@ -225,7 +235,7 @@ Input|`<C-l>`|Move right.
Input|`<C-j>`|Move down.
Input|`<C-k>`|Move up.
#### Telescope.
### Telescope.
Mode|Key|Action
---|---|---
@ -236,14 +246,14 @@ Normal|`<Space>fh`|Find help.
Normal|`<Space>ft`|Find treesitter (vars, functions etc).
Normal|`<Space>fa`|Find all (default treesitter window).
#### Terminal.
### Terminal.
Mode|Key|Action
---|---|---
Normal|`<Space>4`|Open terminal.
Terminal|`<Esc>`|Detach from terminal.
#### To-do.
### To-do.
Write `TODO:` or `NOTE:` to make it searchable.
@ -251,23 +261,19 @@ Mode|Key|Action
---|---|---
Normal|`<Space>3`|Open to-do list.
#### Trouble.
### Trouble.
Mode|Key|Action
---|---|---
Normal|`<Space>2`|Open LSP trouble list.
#### Update.
Run `:Update` to update everything.
#### Which key.
### Which key.
Mode|Key|Action
---|---|---
Normal|`<Space>0`|Show context hotkey help.
#### Window management.
### Window management.
Mode|Key|Action
---|---|---