From 7b028ca8852a058c94ccb9823dc6c55bc7e5f68f Mon Sep 17 00:00:00 2001
From: Bluemedia <oliver@traber-info.de>
Date: Sat, 12 Oct 2024 19:18:39 +0200
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..eabc330
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# My personal Linux desktop setup
+This repo contains a ansible playbook to bootstrap workstations with my custom Hyprland based desktop environment and commonly used apps.
+It's like a dotfile repo, but with extended functionality.
+
+## Customization
+The playbook renders the config based on the configured host variables for the machine that it's running on.
+
+To add a new host, add it's hostname to the inventory and create a corresponding host_vars file. You can take a look at the already existing configuation as an example. 
+
+## Usage
+This playbook is intended to run on Debian testing/sid with only the "default tools" options selected at the time of install.
+
+Run the folowing commands to get a ready to use system:
+```bash
+git clone https://git.bluemedia.dev/Bluemedia/desktop-config.git
+cd desktop-config
+bash prerequisites.sh
+# Uncomment apps you want to install
+nano main.yml
+ansible-playbook --ask-become-pass -i inventory/ main.yml
+# Reboot after the playbook finished
+sudo reboot
+```
+
+To update a installed system:
+```bash
+cd desktop-config
+git pull
+ansible-playbook --ask-become-pass -i inventory/ main.yml
+# Reboot after the playbook finished
+sudo reboot
+```