From 2aa19d56080f8d9523729bc0b536a990c7a85809 Mon Sep 17 00:00:00 2001
From: Daniel-I-Am <djdecloet@gmail.com>
Date: Mon, 27 Dec 2021 12:28:12 +0100
Subject: [PATCH] Add some documentation in the form of a readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6495424
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Daniel's dotfile generator
+
+## Installing
+Enter a python venv
+```sh
+python -m venv env
+source env/bin/activate
+```
+
+Install dependencies
+```
+pip install -r requirements.txt
+```
+
+Setup local variables
+```
+cp local.env.example local.env
+```
+
+Please edit `local.env` to your liking.
+
+## Running/Generating dotfiles
+Run `run.py` from the python venv
+```
+./run.py
+```
+