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: cargo install instruction

Browse source
This commit is contained in:
iff 2024-09-18 16:20:15 +02:00
parent 006e198240
commit 94badac1ef
1 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -41,17 +41,17 @@ Currently, only corrections to `bash`, `zsh`, and `fish` are working flawlessly.
If you are using Arch Linux, you can install from AUR directly:
```shell
paru -S pay-respects
paru -S pay-respects # compile from source
paru -S pay-respects-bin # binary version
```
Or if you have cargo installed, you can install it from [crates.io](https://crates.io/):
```
cargo install pay-respects
```
Alternatively, you can download Linux binary from [releases](https://github.com/iffse/pay-respects/releases).
Otherwise, you can use cargo to compile the project:
```
cargo build --release
```
and the binary can be found at `target/release/pay-respects`.
## 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!