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: cleanup

Browse source
This commit is contained in:
iff 2025-04-22 15:38:16 +02:00
parent 7506af9147
commit 3eba91caf6
4 changed files with 52 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,8 +1,11 @@
# Runtime Rules Module
Module for [pay-respects](https://codeberg.org/iff/pay-respects) which allows you to parse rules at runtime.
Module for [pay-respects] which allows you to add 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).
Syntax is currently 100% compatible with [upstream's compile-time rules].
[pay-respects]: https://codeberg.org/iff/pay-respects
[upstream's compile-time rules]: https://codeberg.org/iff/pay-respects/src/branch/main/rules.md
Rules are searched in these directories:
@ -10,4 +13,8 @@ Rules are searched in these directories:
- `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.
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.
An exception is `_PR_GENERAL.toml` that is always parsed.