summaryrefslogtreecommitdiffstats
path: root/.config/nvim/README.md
diff options
context:
space:
mode:
Diffstat (limited to '.config/nvim/README.md')
-rw-r--r--.config/nvim/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/.config/nvim/README.md b/.config/nvim/README.md
new file mode 100644
index 0000000..dc0deaa
--- /dev/null
+++ b/.config/nvim/README.md
@@ -0,0 +1,9 @@
+**This repo is supposed to used as config by NvChad users!**
+
+- The main nvchad repo (NvChad/NvChad) is used as a plugin by this repo.
+- So you just import its modules , like `require "nvchad.options" , require "nvchad.mappings"`
+- So you can delete the .git from this repo ( when you clone it locally ) or fork it :)
+
+# Credits
+
+1) Lazyvim starter https://github.com/LazyVim/starter as nvchad's starter was inspired by Lazyvim's . It made a lot of things easier!