Move from github

1 files changed, 66 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..08b4293
--- /dev/null
+++ b/README.md
@@ -0,0 +1,66 @@
+# My Neovim Config
+![nvim](https://user-images.githubusercontent.com/91333841/212791030-440472c6-1568-4754-9181-c47e69bc42d6.png)
+
+### Introduction
+Run checkhealth in your Neovim
+```vim
+:checkhealth
+```
+Make sure you analyzed the output properly: 
+- Your neovim must be >= 0.7.0 to run this config 
+- You need to setup [Packer](https://github.com/wbthomason/packer.nvim)
+```vim
+git clone --depth 1 https://github.com/wbthomason/packer.nvim\
+ ~/.local/share/nvim/site/pack/packer/start/packer.nvim
+```
+- You should install global python provider 
+```python
+pip install pynvim
+```
+- You should install clipboard tool (I use xclip but you can use something diffrent) 
+
+### Installation
+> Easy way
+
+You can just clone this repo to your .config folder
+
+```bash
+git clone https://github.com/dsrcr/nvim ~/.config
+```
+> Recommended way
+
+I use gnu-stow to manage my dotfiles, so I encourage you to use it too.
+
+Use your package manage of choice to get stow, for example: 
+
+```bash
+paru -S stow
+```
+Clone this repo to your prefered dir and use stow to symlink
+
+In order to do this you need an empty nvim directory in your .config folder
+```bash
+cd ~/.config
+mkdir nvim
+cd ~/yourDirectory
+git clone https://github.com/dsrcr/nvim
+stow -d ~/yourDirectory -t ~/.config/nvim nvim/
+
+```
+
+The last step is running this command in your neovim
+
+```vim
+:PackerSync
+```
+This command should pull everything you need
+
+In the next step you will encounter a lot of errors, but don't worry about it.
+Packer needs to pull specific plugins and then you need to install Treesitter's support for specific filetypes eg. lua, rust.... etc.
+```bash
+:TSUpdate
+```
+```bash
+:TSInstall
+```
+