From 924717f31e661aceea9063122ae345f9bab0d443 Mon Sep 17 00:00:00 2001
From: Candifloss <candifloss@candifloss.cc>
Date: Fri, 6 Dec 2024 10:54:29 +0000
Subject: [PATCH] Update leftwm/README.md

---
 leftwm/README.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/leftwm/README.md b/leftwm/README.md
index b4fbef4..0146ba8 100644
--- a/leftwm/README.md
+++ b/leftwm/README.md
@@ -1,4 +1,27 @@
 # LeftWM  
 
 Config for [LeftWM](https://github.com/leftwm/leftwm), a window manager written in rust. The current config contains basic keybindings and workspace specified for few apps. Gaps, colors, themes, etc., are not configured yet.  
-Config location: `~/.config/leftwm/config.ron`  
\ No newline at end of file
+Config location: `~/.config/leftwm/config.ron`  
+
+## Theme config  
+
+The scripts and config files for the theme must be in a directory sym-linked to `~/.config/leftwm/themes/current/`.  
+Minimum required files:  
+- `theme.ron`: LeftWM theme config including border color, margins, etc.  
+- `up`: This script is called on login. The `theme.ron` must be loaded by this script using LeftWM's `LoadTheme` command:  
+```bash
+leftwm command "LoadTheme ~/.config/leftwm/themes/current/theme.ron"
+```  
+  Add lines to load other theme elements like `eww daemon`, `polybar`, or anything you have configured for your desktop.  
+- `down`: To unload the theme.  
+
+```
+~/.config/
+└── leftwm/
+    ├── config.ron
+    └── themes/
+        └── current/
+            ├── theme.ron
+            ├── up
+            └── down
+```
\ No newline at end of file