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

Browse source
This commit is contained in:
iff 2023-08-04 03:04:26 +02:00
parent 76cdb1908d
commit 51d4af31b8
1 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -1,6 +1,6 @@
# Pay Respects
Typed a wrong command? Pay Respects will try to correct your wrong console command simply by pressing `F`!
Typed a wrong command? Pay Respects will try to correct your wrong console command by simply pressing `F`!
![example-sudo-echo](img/example-sudo-echo.png)
@ -48,9 +48,9 @@ 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.
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!
Syntax of a rule file (placed under [rules](./rules)):
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
command = "world"
@ -103,5 +103,7 @@ The suggestion can have additional conditions to check. To specify the condition
## Current Progress
We need more rule files!
Current option to write rules should cover most of the cases.
We need more rule files, contributions are welcomed!