From ff0328765c04614701bbfe793bb228cd63f1b2fc Mon Sep 17 00:00:00 2001
From: axtloss <axtlos@getcryst.al>
Date: Tue, 28 May 2024 20:01:57 +0200
Subject: add readme and fix some warnings

---
 README.md | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index bc2ee88..a2a5395 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,35 @@
 # autodarkmode
 
-A description of this project.
+A simple tool to switch between dark and light mode.
+
+It executes a command on switch and nothing else.
+Location is either specified by the user or 
+
+# Building
+```
+meson setup _build
+cd build
+meson compile
+```
+the resulting binary `src/autodarkmode` can then be moved to any directory in PATH.
+
+# Configuration
+```ini
+[main]
+; can be 'manual' or 'gclue'
+locationtype = "manual"
+
+[manual]
+; set latitude and longitude in case that locationtype is set to manual
+latitude = -10.0
+longitude = -5.0
+
+[light]
+; command to execute for light mode
+cmd = "notify-send 'a'"
+
+[dark]
+; command to execute for dark mode
+cmd = "notify-send 'b'"
+```
+autodarkmode expects to find this configuration in `$XDG_CONFIG_HOME/autodarkmode/config.ini`, in the case that XDG_CONFIG_HOME is empty, it will use `~/.config/autodarkmode/config.ini`
-- 
cgit v1.2.3