From ab7b20a1af0c06e1bcbb6525fd97e3942cd69e98 Mon Sep 17 00:00:00 2001
From: xesc <xesc@xesc.de>
Date: Sat, 9 Dec 2023 20:33:05 +0100
Subject: [PATCH] adds readme

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

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..2a69447
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,28 @@
+# Configs
+Welcome to my configs, feel free to use and modify them as you like!
+
+To install all of them to your system, just `$ make install`.
+
+If you just want some of them, use `$ make <directory_name>` for a specific application.
+
+---
+
+### You want to know what would happen on install without installing anything yet?
+
+For a dry-run of any of the targets, just prepend `-dry` to the targets name.
+> Note: 
+> This management relies on GNU Stow, so to work properly, please ensure you have 'stow' installed... 
+
+--- 
+
+### You don't want to use a config anymore? 
+
+Prepend `-uninstall` to any config installed via the `install`-command from earlier.
+
+### To much stuff you don't need?
+
+Check out `https://git.xesc.de/xesc` for the individual repos of the applicatons.
+
+--- 
+
+Have fun :)