History

Mark d8b78f78f3 Documentation		2022-11-04 22:17:45 -07:00
..
backlight	Cleaned up keybinds	2022-07-17 20:29:08 -07:00
battery	Fixed a few errors	2022-09-10 21:52:40 -07:00
ibus	Added ibus hook for host interface	2022-08-03 18:04:09 -07:00
keymap_popup	Added basic keymap popup	2022-09-30 22:13:33 -07:00
launcher	Improve rofi config	2022-11-04 21:20:18 -07:00
lock	Improved lock module	2022-11-04 10:23:41 -07:00
mpc	Minor cleanup	2022-07-16 19:12:29 -07:00
picom	Added picom module, fixed module loading	2022-11-04 22:04:06 -07:00
screenshot	Remove pdf in screenshot script	2022-08-03 18:05:24 -07:00
simple_widgets	Added app icons	2022-07-23 16:27:13 -07:00
volume	Minor cleanup	2022-07-16 19:12:29 -07:00
README.md	Documentation	2022-11-04 22:17:45 -07:00

README.md

Mark's Awesomewm Config

Dependencies

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.

Core: fish
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

Modules

Modules are parts of this configuration that can be disabled. Nearly all features in this config are defined by a module.

Enable / Disable Modules

See config-template.lua

Organization

Every directory in modules/ is a module. Modules cannot be in subdirectories.
Each module directory MUST have an init.lua, which returns a table. That table can contain anything, but a few keys are special:

keybinds
Defines keybinds the module provides. It is audomatically loaded if the module is enabled.
This MUST be a table formed by awful.key(). See ibus or screenshot for examples.

init
Defines an init method. This is called once when awesome starts.