From 9ef45b852974cf264c95a881f262eb2ec14c4000 Mon Sep 17 00:00:00 2001
From: waldek <waldek@86thumbs.lan>
Date: Wed, 16 Mar 2022 18:55:51 +0100
Subject: [PATCH] adds a quick readme

---
 readme.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..2a2dd32
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,15 @@
+# Installation
+
+```bash
+sudo apt install -y vim-nox git python3-pip python3-venv npm
+mkdir -p $HOME/sources/
+cd $HOME/sources
+git clone https://gitea.86thumbs.net/waldek/vimrc.git
+ln -s $HOME/sources/vimrc/main.vimrc $HOME/.vimrc
+```
+
+# Customization
+
+The `main.vimrc` file is the entry point which reads all the other files.
+If your user name is not `waldek` it won't read the `waldek_plugins.list` nor the `waldek_plugins.vimrc`.
+You can add your own files by creating these two files but with your own username.