awesomewm/README.md

23 lines
686 B
Markdown
Raw Normal View History

2022-11-05 08:08:15 -07:00
# Mark's Awesomewm Config
2021-08-01 07:24:26 -07:00
2022-11-05 08:08:15 -07:00
## Setup
2022-09-16 08:13:18 -07:00
Copy config.lua.template into config.lua before using.
2021-08-01 07:24:26 -07:00
2022-11-05 08:08:15 -07:00
## Modules
See the [modules](./modules/README.md) README.
2021-08-01 07:24:26 -07:00
## Dependencies
2022-11-05 08:08:15 -07:00
Some features require extra tools. Tools each module requires are listed below. If a module is disabled, its tool is not needed. Applications required by `core` MUST be installed.
2022-11-05 09:46:56 -07:00
- Core: `fish`, `sox` (and plugins)
2022-11-05 08:08:15 -07:00
- Backlight: `xbacklight`
- Battery: `upower`
- Ibus: `ibus`
- Launcher: `rofi`
- Lock: `i3lock, imagemagick, scrot` or `lightdm` (For `dm-tool`), depending on configuration.
- MPC: `mpc`
- Picom: `picom`
- Screenshot: `flameshot`, `tesseract (and data)`, `xclip`, `lpr`
- Volume: `pamixer`
2021-08-01 07:24:26 -07:00