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

doc: update directories

Browse source
This commit is contained in:
iff 2024-11-16 01:32:42 +01:00
parent 284b807b9e
commit 49f54bb03f
1 changed files with 7 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
rules.md
View file

@ -7,7 +7,13 @@ For compile-time rules, if only rules are changed, cargo won't recompile the pro
touch src/rules.rs && cargo build
```
Runtime rules should be placed under `$XDG_CONFIG_HOME/pay-respects/rules/`, for example `$HOME/.config/pay-respects/rules/cargo.toml`. The name of the runtime rule **MUST** match the command name.
Runtime rules directories are searched, by the order or priority:
- `XDG_CONFIG_HOME`
- `XDG_CONFIG_DIRS`
- `XDG_DATA_DIRS`
The actual rule file should be placed under `pay-respects/rules/`, for example: `~/.config/pay-respects/rules/cargo.toml`. Note that for runtime rules, the name of the file **MUST** match the command name.
Syntax of a rule file:
```toml