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

update: Installation

Browse source
This commit is contained in:
iff 2023-07-30 22:10:55 +02:00
parent d29af0e3d7
commit 58af6c17fc
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -7,10 +7,24 @@ Typed a wrong command? Pay Respect will try to correct your wrong console comman
The binary is named `pay-respect`, by adding an alias to your shell
configuration:
``` shell
# Note: You may need to have the binary exposed in your path
alias f="pay_respect"
```
You can now **press `F` to Pay Respect**!
## Installing
If you are using Arch Linux, you can install from AUR directly:
```shell
paru -S pay_respect
```
Otherwise, you can use cargo to compile the project:
```
cargo build --release
```
and the binary can be found at `target/release/pay_respect`.
## Rule Files
Rule files are parsed at compilation. What actually gets compiled is a HashMap that contains patterns and suggestions for a specific command.