technofab/pay-respects
1
0
Fork 0
mirror of https://github.com/TECHNOFAB11/pay-respects.git synced 2025-12-11 22:10:09 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: module readmes

Browse source
This commit is contained in:
iff 2025-02-12 17:22:00 +01:00
parent 8269ee4197
commit 5e32873966
3 changed files with 84 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

13
module-runtime-rules/README.md Normal file
View file

@ -0,0 +1,13 @@
# Runtime Rules Module
Module for [pay-respects](https://codeberg.org/iff/pay-respects) which allows you to parse rules at runtime.
Syntax is currently 100% compatible with [upstream's compile-time rules](https://codeberg.org/iff/pay-respects/src/branch/main/rules.md).
Rules are searched in these directories:
- `XDG_CONFIG_HOME`, defaults to `$HOME/.config`.
- `XDG_CONFIG_DIRS`, defaults to `/etc/xdg`.
- `XDG_DATA_DIRS`, defaults to `/usr/local/share:/usr/share`.
The actual rule file should be placed under `pay-respects/rules/`, for example: `~/.config/pay-respects/rules/cargo.toml`. To avoid parsing unnecessary rules, the name of the file **MUST** match the command name.