Added modules readme

master
Mark 2022-07-16 18:00:58 -07:00
parent 9548bfc9b2
commit 9da54839fb
Signed by: Mark
GPG Key ID: AD62BB059C2AAEE4
1 changed files with 15 additions and 0 deletions

15
modules/README.md Normal file
View File

@ -0,0 +1,15 @@
# Modules
Modules are parts of this configuration that can be disabled. Nearly all features in this config are defined by a module.
## 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.