diff --git a/README.md b/README.md index 1f643f0..a8ae2d7 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,154 @@ # swarmlab-nvim + + + + + +This is the area where you we guide you to Install and use NeoVim + + +== Pre-Installation Steps + + +=== Clone repo + +[source,bash] +---- +mkdir [dir4project] +cd [dir4project] +GIT_SSL_NO_VERIFY=true git clone https://git.swarmlab.io:3000/docs/docs/src/branch/master +---- + + + +== Key map features + +I try to avoid C- combinations for the things I do frequently, mapping things that make sense to the key. + +The leader key provides a facility for creating customized shortcuts that can be further restricted to apply only in certain modes, such as normal, insert, visual, terminal (neovim-specific), etc. + +The leader key is normally defined by the mapleader variable as \. + +== Normal mode + +=== Edit Action + +[cols="1,2",grid=none, frame=none] +|=== +| *\ls* | Remove all whitespace at the end of every line in the buffer +| *p* | Paste below +| *P* | Paste above +|=== + +Select text with: *CTRL-V* -or- *SHIT-V* amd Arrows + +AND + +*esc Y* to Copy + +use: *Clipboard/Register Manager* to *paste* + +=== View Action + +[cols="1,2",grid=none, frame=none] +|=== +| *\n* | Toggle line numbers +| *\w* | Toggle wrap +|=== + +=== Copy2System Buffer + +* 1. Select text: +** CTRL + V -OR- SHIFT + V +** and use Arrows to select +* 2. CTRL + C Copy +* 3. SHIFT + INS Paste + + +=== Clipboard/Register Manager + +[cols="1,2",grid=none, frame=none] +|=== +| *\r* | Open Register Menou +| *Esc* | Close Register Menou +| *p* | Paste below +| *CTRL-p* | Paste above +|=== + +=== Menou / File explorer + +[cols="1,2",grid=none, frame=none] +|=== +| *Space* | Toggle NERD Tree, a file tree explorer. +| *\h* | Toggle distraction free mode (hide/show both nerdtree and tagbar) +| *\tb* | Toggle tagbar +|=== + +=== Open File with explorer + +[cols="1,2",grid=none, frame=none] +|=== +| *Space* | Toggle NERD Tree, a file tree explorer. +| *s* | open file in new Buffer (vertical split) +| *i* | open file in new Buffer (horizontal split) +| *ENTER* | open file in current Buffer +| *SHIFT + R* | reload explorer view +|=== + +=== Buffers / Split + +[cols="1,2",grid=none, frame=none] +|=== +| | +| *\bv* | Create a new (empty) buffer to the right of a vertical split +| *\bv* | Create a new (empty) buffer to the right of a vertical split +| *\bh* | Create a new (empty) buffer below a horizontal split +| *\bk* | Kill current buffer (don't prompt to save changes) +| *\bl* | List buffers +| *\bg* | List and select buffer by # +| *ALT - [Left arrow]* | Go to buffer to the left +| *ALT - [Down arrow]* | Go to buffer below +| *ALT - [Up arrow]* | Go to buffer above +| *ALT - [Right arrow]* | Go to buffer to the right +|=== + +=== Resize Buffers / Split + +Try: + +* CTRL + [LEFT SHIFT] + [Left arrow] +* CTRL + [LEFT SHIFT] + [Down arrow] +* CTRL + [LEFT SHIFT] + [Up arrow] +* CTRL + [LEFT SHIFT] + [Right arrow] + +=== Terminal + +[cols="1,2",grid=none, frame=none] +|=== +| *\tt* | Open a full screen terminal +| *\tv* | Open a terminal in a new split to the right +| *\th* | Open a terminal in a new split below +|=== + +=== Tabs + +[cols="1,2",grid=none, frame=none] +|=== +| *create tab* | esc :tabnew +| *SHIFT* | Go to Tab to the right +| *SHIFT - TAB* | Go to Tab to the left +|=== + +=== Theme + +* \c Toggle between light and dark backround modes (for supported themes) + +== Insert mode + +=== Greek/Latin letters +* Greek characters +* Latin characters + +=== Spell check +* ctrl-x s