aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 26 insertions, 7 deletions
diff --git a/README.md b/README.md
index 08b4293..77b2080 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,35 @@
1# My Neovim Config 1# Overview
2
2![nvim](https://user-images.githubusercontent.com/91333841/212791030-440472c6-1568-4754-9181-c47e69bc42d6.png) 3![nvim](https://user-images.githubusercontent.com/91333841/212791030-440472c6-1568-4754-9181-c47e69bc42d6.png)
3 4
4### Introduction 5### Installation
6
5Run checkhealth in your Neovim 7Run checkhealth in your Neovim
8
6```vim 9```vim
7:checkhealth 10:checkhealth
8``` 11```
9Make sure you analyzed the output properly: 12
10- Your neovim must be >= 0.7.0 to run this config 13Make 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
13git clone --depth 1 https://github.com/wbthomason/packer.nvim\ 19git 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
18pip install pynvim 26pip 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
25You can just clone this repo to your .config folder 35You 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
28git clone https://github.com/dsrcr/nvim ~/.config 38git clone https://github.com/dsrcr/nvim ~/.config
29``` 39```
40
30> Recommended way 41> Recommended way
31 42
32I use gnu-stow to manage my dotfiles, so I encourage you to use it too. 43I use gnu-stow to manage my dotfiles, so I encourage you to use it too.
33 44
34Use your package manage of choice to get stow, for example: 45Use your package manage of choice to get stow, for example:
35 46
36```bash 47```bash
37paru -S stow 48paru -S stow
38``` 49```
50
39Clone this repo to your prefered dir and use stow to symlink 51Clone this repo to your prefered dir and use stow to symlink
40 52
41In order to do this you need an empty nvim directory in your .config folder 53In order to do this you need an empty nvim directory in your .config folder
54
42```bash 55```bash
43cd ~/.config 56cd ~/.config
44mkdir nvim 57mkdir 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
56This command should pull everything you need 70This command should pull everything you need
57 71
58In the next step you will encounter a lot of errors, but don't worry about it. 72In the next step you will encounter a lot of errors, but don't worry about it.
59Packer needs to pull specific plugins and then you need to install Treesitter's support for specific filetypes eg. lua, rust.... etc. 73Packer 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
85This 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)