Yessiest
/
awesome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added stuff to README

This commit is contained in:
Yessiest 2021-11-14 14:56:28 +04:00
parent 4cacdd9bd7
commit 333859dbc4
2 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.txt
View File

@ -2,7 +2,7 @@ This folder is the root of awesomewm configuration.
The layout is as follows:
/core - original rc.lua, split into components for convenience.
/core/widgets - self-contained widgets from original awesomewm rc.lua.
/modules - small self-contained plug-ins to be required in rc.lua.
/modules - small self-contained plug-ins to be "required" in rc.lua.
/libs - libraries, for various purposes.
/widgets - custom widgets
/various-scripts - scripts for clearing up desktop files, installing pam, etc.

21
core/README.txt
View File

@ -1,18 +1,23 @@
These are the core modules of this desktop.
There are currently the following modules, in the order of loading:
1) error.lua - Error handling
2) vars.lua - Variable definitions
3) style.lua - ``beautiful`` theme and style definitions
4) binds.lua - Binds
5) layout.lua - Wibar layout
6) rules.lua - Rules
7) signals.lua - Signals
1) error.lua - Error handling
2) vars.lua - Variable definitions
3) style.lua - ``beautiful`` theme and style definitions
4) binds.lua - Binds
5) layout.lua - Wibar layout
6) rules.lua - Rules
7) signals.lua - Signals
Some of the modules were further split into distinct components:
1) client.lua - Additional client hook to be run when a client is created.
2) titlebar.lua - Titlebar configuration, also run when a client is created.
3) widgets/* - Default widgets and their parameters.
Notice that Error handling and Variable definitions come before beautiful
initialization. That is normal. Those modules don't depend on any of the
above, therefore they are loaded before anything else.
Additionally, notice that Binds come before Wibar. That is not exactly how it
Additionally, notice that Binds come before layout. That is not exactly how it
was in the default rc.lua, but it is important to load them in exactly that
order. Widgets, which are called from layout.lua, override the global bindings
table. If you load binds after the layout is loaded, the bindings are reset to