about summary refs log tree commit diff
path: root/modules/README.md
diff options
context:
space:
mode:
authorsternenseemann <0rpkxez4ksa01gb3typccl0i@systemli.org>2021-02-09 01:00:09 +0100
committersternenseemann <sternenseemann@systemli.org>2021-02-13 12:27:27 +0100
commite6805d46f31e8228ad590775c7967bceea47fe46 (patch)
treea7e88dafa2691e274f1cf481a737a9cda8c24838 /modules/README.md
parent5b73fbf6989b48e5c4f35f671338d880acece2d0 (diff)
modules/user/profpatsch: adjust naming scheme
The general consensus seems to be to use

    vuizvui.user.<username>.<category>.<module name>

instead of

    vuizvui.<category>.<user name>.<module name>

Things done to test this change:

* Checked build of machines.profpatsch.legosi.build
* Checked evaluation of machines.profpatsch.shiki.build
Diffstat (limited to 'modules/README.md')
-rw-r--r--modules/README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/modules/README.md b/modules/README.md
index d9dd5851..a2a6ec89 100644
--- a/modules/README.md
+++ b/modules/README.md
@@ -36,7 +36,9 @@ When writing modules, make sure to categorize them accordingly:
 </table>
 
 If a module is highly specific to your own configuration, use the same
-categories but put them under `user/$category/$module`.
+categories but put them under `user/$username/$category/$module`.
+Their configuration options should be named
+`vuizvui.user."${username}".*` accordingly.
 
 Don't forget to add your module to `module-list.nix`, but make sure you have
 options in place to disable them by default.