initial commit

1 files changed, 44 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5a3b001
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+Neovim Config
+=============
+
+## What is this?
+These are my personal configuration for neovim.
+
+## How to use this config?
+This Configuration works best in GNU/Linux platform. Other systems are also supported, but they see less testing, so expect more bugs.
+Supported Systems:
+- MS Windows, preferably running on MSYS2 Environment (Running on MS Windows directly is untested)
+- Android, on Termux
+- Theoretically it runs on MacOS and BSDs, but it’s untested, as I don’t have access to any MacOS/BSD system (yet)
+
+### Neovim Version
+This configuration can only be used with Neovim version 0.5 and up
+
+### External Dependencies
+Some plugins require python extensions for neovim
+
+#### Language Servers
+
+
+### Installation
+1. Download/Clone this git repo to ```$HOME/.config/nvim```
+```sh
+mkdir -p  $HOME/.config
+git clone "https://gitlab.com/telosama/neovim-config.git" $HOME/.config/nvim
+```
+3. Start Neovim , then do this command: 
+```
+:PackerSync
+:PackerCompile
+:COQdeps
+```
+And Done!
+
+## Philosophy
+- Just to keep it as simple as possible
+- It's a text editor, not an IDE, so just keep simple plugins to help text editing.
+- These are not rules, they are more of a suggestion/guideline
+
+## Support/Contribution
+As can be seen, the author of this repo is a beginner in english and programming, especially in Lua & Git.
+So, any constructive help, criticism, contributions are very welcome.