diff --git a/README.md b/README.md index 7592f45..a0a65a1 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,17 @@ # LeftWM Config files Config for [LeftWM](https://github.com/leftwm/leftwm), a window manager written in rust. -Config location: `~/.config/leftwm/config.ron` +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/ + ├── current/ -> my_theme + └── my_theme/ ├── theme.ron ├── up └── down diff --git a/themes/README.md b/themes/README.md new file mode 100644 index 0000000..60b2d6a --- /dev/null +++ b/themes/README.md @@ -0,0 +1,11 @@ +# Theme config + +The scripts and config files for the theme must be in a directory sym-linked to `~/.config/leftwm/themes/current/`. + +- `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. Not sure why this is required. I might modify thislater if required. \ No newline at end of file