From 54322611719de11d6efbf1048b652851ab57e8e5 Mon Sep 17 00:00:00 2001
From: Aotrix <aotrix56@gmail.com>
Date: Wed, 26 Feb 2025 23:26:35 +0100
Subject: added instructions to use the config

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

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.
-- 
cgit v1.2.3