diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 33 |
1 files changed, 26 insertions, 7 deletions
| @@ -1,25 +1,35 @@ | |||
| 1 | # My Neovim Config | 1 | # Overview |
| 2 | |||
| 2 |  | 3 |  |
| 3 | 4 | ||
| 4 | ### Introduction | 5 | ### Installation |
| 6 | |||
| 5 | Run checkhealth in your Neovim | 7 | Run checkhealth in your Neovim |
| 8 | |||
| 6 | ```vim | 9 | ```vim |
| 7 | :checkhealth | 10 | :checkhealth |
| 8 | ``` | 11 | ``` |
| 9 | Make sure you analyzed the output properly: | 12 | |
| 10 | - Your neovim must be >= 0.7.0 to run this config | 13 | Make sure you analyzed the output properly: |
| 14 | |||
| 15 | - Your neovim must be >= 0.7.0 to run this config | ||
| 11 | - You need to setup [Packer](https://github.com/wbthomason/packer.nvim) | 16 | - You need to setup [Packer](https://github.com/wbthomason/packer.nvim) |
| 17 | |||
| 12 | ```vim | 18 | ```vim |
| 13 | git clone --depth 1 https://github.com/wbthomason/packer.nvim\ | 19 | git clone --depth 1 https://github.com/wbthomason/packer.nvim\ |
| 14 | ~/.local/share/nvim/site/pack/packer/start/packer.nvim | 20 | ~/.local/share/nvim/site/pack/packer/start/packer.nvim |
| 15 | ``` | 21 | ``` |
| 16 | - You should install global python provider | 22 | |
| 23 | - You should install global python provider | ||
| 24 | |||
| 17 | ```python | 25 | ```python |
| 18 | pip install pynvim | 26 | pip install pynvim |
| 19 | ``` | 27 | ``` |
| 20 | - You should install clipboard tool (I use xclip but you can use something diffrent) | 28 | |
| 29 | - You should install clipboard tool (I use xclip but you can use something diffrent) | ||
| 21 | 30 | ||
| 22 | ### Installation | 31 | ### Installation |
| 32 | |||
| 23 | > Easy way | 33 | > Easy way |
| 24 | 34 | ||
| 25 | You can just clone this repo to your .config folder | 35 | You can just clone this repo to your .config folder |
| @@ -27,18 +37,21 @@ You can just clone this repo to your .config folder | |||
| 27 | ```bash | 37 | ```bash |
| 28 | git clone https://github.com/dsrcr/nvim ~/.config | 38 | git clone https://github.com/dsrcr/nvim ~/.config |
| 29 | ``` | 39 | ``` |
| 40 | |||
| 30 | > Recommended way | 41 | > Recommended way |
| 31 | 42 | ||
| 32 | I use gnu-stow to manage my dotfiles, so I encourage you to use it too. | 43 | I use gnu-stow to manage my dotfiles, so I encourage you to use it too. |
| 33 | 44 | ||
| 34 | Use your package manage of choice to get stow, for example: | 45 | Use your package manage of choice to get stow, for example: |
| 35 | 46 | ||
| 36 | ```bash | 47 | ```bash |
| 37 | paru -S stow | 48 | paru -S stow |
| 38 | ``` | 49 | ``` |
| 50 | |||
| 39 | Clone this repo to your prefered dir and use stow to symlink | 51 | Clone this repo to your prefered dir and use stow to symlink |
| 40 | 52 | ||
| 41 | In order to do this you need an empty nvim directory in your .config folder | 53 | In order to do this you need an empty nvim directory in your .config folder |
| 54 | |||
| 42 | ```bash | 55 | ```bash |
| 43 | cd ~/.config | 56 | cd ~/.config |
| 44 | mkdir nvim | 57 | mkdir nvim |
| @@ -53,14 +66,20 @@ The last step is running this command in your neovim | |||
| 53 | ```vim | 66 | ```vim |
| 54 | :PackerSync | 67 | :PackerSync |
| 55 | ``` | 68 | ``` |
| 69 | |||
| 56 | This command should pull everything you need | 70 | This command should pull everything you need |
| 57 | 71 | ||
| 58 | In the next step you will encounter a lot of errors, but don't worry about it. | 72 | In the next step you will encounter a lot of errors, but don't worry about it. |
| 59 | Packer needs to pull specific plugins and then you need to install Treesitter's support for specific filetypes eg. lua, rust.... etc. | 73 | Packer needs to pull specific plugins and then you need to install Treesitter's support for specific filetypes eg. lua, rust.... etc. |
| 74 | |||
| 60 | ```bash | 75 | ```bash |
| 61 | :TSUpdate | 76 | :TSUpdate |
| 62 | ``` | 77 | ``` |
| 78 | |||
| 63 | ```bash | 79 | ```bash |
| 64 | :TSInstall | 80 | :TSInstall |
| 65 | ``` | 81 | ``` |
| 66 | 82 | ||
| 83 | ### Further development | ||
| 84 | |||
| 85 | This is the only text editor on my system, so I'll be adding updates as long as I find something better(not gonna happen soon) | ||
