Documentation

config-template.lua

@@ -1,12 +1,19 @@
 local config = {}
 
+-- Copy this file to `config.lua` before starting awesome.
+
+-- To enable a module, add a line like the ones below.
+-- To disable a module, delete its config table or set
+-- enabled to false.
+
+config.picom = { enabled = true }
+config.lock = { enabled = true, type = "i3lock"}
 config.battery = { enabled = false }
 config.backlight = { enabled = false }
 config.simple_widgets = { enabled = true }
 config.launcher = { enabled = true }
 config.screenshot = { enabled = true }
 config.keymap_popup = { enabled = true }
-config.lock = { enabled = true, type = "i3lock"}
 
 config.core = {
 	wallpaper = "/home/assets/wallpapers/Themed/Stellaris/Gigapixel/City.png",

modules/README.md

@@ -1,8 +1,29 @@
-# Modules
+# 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.
 
-## Organization
+### 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: