Updated READMEs
This commit is contained in:
parent
803771a413
commit
2b12a81bfe
15
README.md
15
README.md
@ -1,26 +1,17 @@
|
|||||||
# LeftWM Config files
|
# LeftWM Config files
|
||||||
|
|
||||||
Config for [LeftWM](https://github.com/leftwm/leftwm), a window manager written in rust.
|
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:
|
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/
|
~/.config/
|
||||||
└── leftwm/
|
└── leftwm/
|
||||||
├── config.ron
|
├── config.ron
|
||||||
└── themes/
|
└── themes/
|
||||||
└── current/
|
├── current/ -> my_theme
|
||||||
|
└── my_theme/
|
||||||
├── theme.ron
|
├── theme.ron
|
||||||
├── up
|
├── up
|
||||||
└── down
|
└── down
|
||||||
|
11
themes/README.md
Normal file
11
themes/README.md
Normal file
@ -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.
|
Loading…
Reference in New Issue
Block a user