Add README.md

README.md

@@ -0,0 +1,44 @@
+Fully featured neo-vim configuration
+====================================
+
+This repository contains my personnal neovim setup, intended to replace my old [vim setup]('https://git.steins7.ovh/Steins7/vim').
+
+Next are a few usefull informations that I mainly wrote for me to remember but that should allow you
+to use the same setup as me if you want to.
+
+Installation
+------------
+
+### Clone the repository
+
+This will create a new nvim folder in your .config folder, containing all the configuration stuff
+
+```
+git clone https://github.com/Steins7/nvim ~/.config/nvim
+```
+
+And that's it for the configuration part. Once nvim is started, run `:PloginsUpgrade` wich will fetch all the necessary plugins, store them in `~/.local/nvim` and load them each time you start the editor. At this point, you are ready to install the external depencies needed for all those plugins to work properly.
+
+### External depencies
+
+Here is a list of all external depencies you'll need:
+
+- python 3 (3.8 minimum)
+- python-venv (shipped in python > 3.3)
+- universal ctags, ctags won't work (note that arch's universal ctags package is named ctags...)
+- rust-analyzer
+
+On arch, you can just use the following command :
+```
+pacman -Syu python ctags rust-analyzer
+```
+
+Once the dependencies are installed, COQ may prompt you to execute `COQdeps` and update the dependencies which you should do. Atfter that, either restart nvim or execute `COQnow`.
+
+Tinkering
+---------
+
+The configuration is quite small and straight-forward :
+- init.lua contains all the configuration and key bindings, see more information [here]("https://github.com/nanotee/nvim-lua-guide")
+- lua/plugins.lua contains the list of plugins, see more information [here]("https://github.com/faerryn/plogins.nvim")
+