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: rule recompile instruction

Browse source
This commit is contained in:
iff 2024-09-25 01:22:45 +02:00
parent 19737de708
commit d61881306a
1 changed files with 9 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -54,24 +54,23 @@ cargo install pay-respects
git clone --depth 1 https://github.com/iffse/pay-respects
cd pay-respects
cargo install --path .
# compile without installing
# binary can be found at ./target/release/pay-respects
cargo build --release
```
Alternatively, you can download Linux binary from [releases](https://github.com/iffse/pay-respects/releases).
## Compiling
Using cargo, the process is straight forward:
```shell
git clone --depth 1 https://github.com/iffse/pay-respects
cd pay-respects
cargo build --release
```
## Rule Files
Rule files are parsed at compilation. Everything in rule files is converted to Rust code before compiling. You don't have to know the project structure nor Rust to write the rules!
If only rules are changed, cargo won't recompile the project because Rust code were intact. You will have to notify it manually by:
```shell
touch src/suggestions.rs && cargo build
```
Syntax of a rule file (will be read by simply placing the file under [rules](./rules)):
```toml
# this field should be the name of the command