added instructions to use the config

1 files changed, 12 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a2364bf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# Steps
+- Clone the project in ~/.config/nvim folder
+This is a C++ neovim config which uses clang to analyse your code and LLDB to debug it. Thus, make sure that these tools installed on your system.
+
+On Arch based systems:
+```bash
+sudo pacman -S clang
+sudo pacman -S lldb
+```
+
+You can also use Mason to install these tools.
+Some formatters are used in this config, please check `~/.config/nvim/lua/aotrix/plugins/autoformat.lua` and install or remove the ones you need.