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: update installation

Browse source
This commit is contained in:
iff 2024-12-08 17:46:43 +01:00
parent d0f4083eb3
commit 2c94883bfc
6 changed files with 17 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Cargo.lock generated
View file

@ -480,7 +480,7 @@ dependencies = [
]
[[package]]
name = "pay-respects-fallback-request-ai"
name = "pay-respects-module-request-ai"
version = "0.1.0"
dependencies = [
"colored",
@ -504,7 +504,7 @@ dependencies = [
[[package]]
name = "pay-respects-parser"
version = "0.3.2"
version = "0.3.3"
dependencies = [
"proc-macro2",
"quote",

10
README.md
View file

@ -107,16 +107,20 @@ curl -sSfL https://raw.githubusercontent.com/iffse/pay-respects/main/install.sh
> This installation requires you to have Cargo (the Rust package manager) installed.
> Install from [crates.io](https://crates.io/), features are optional
> Install from [crates.io](https://crates.io/), modules are optional
> ```shell
> cargo install pay-respects --all-features
> cargo install pay-respects
> cargo install pay-respects-module-runtime-rules
> cargo install pay-respects-module-request-ai
> ```
> Clone from git and install, suitable for adding custom compile-time rules:
> ```
> git clone --depth 1 https://github.com/iffse/pay-respects
> cd pay-respects
> cargo install --path .
> cargo install --path core
> cargo install --path module-runtime-rules
> cargo install --path module-request-ai
> ```

2
core/Cargo.toml
View file

@ -21,5 +21,5 @@ regex-lite = "0.1"
inquire = "0.7.5"
pay-respects-parser = { version = "0.3.2", path = "../parser" }
pay-respects-parser = { version = "0.3.3", path = "../parser" }
pay-respects-utils = {version = "0.1.0", path = "../utils"}

5
module-request-ai/Cargo.toml
View file

@ -1,5 +1,5 @@
[package]
name = "pay-respects-fallback-request-ai"
name = "pay-respects-module-request-ai"
version = "0.1.0"
edition = "2021"
@ -19,3 +19,6 @@ curl = { version = "0.4", optional = true }
# complicates cross compilation
libcurl = ["dep:curl"]
[[bin]]
name = "pay-respects-fallback-request-ai"
path = "src/main.rs"

2
parser/Cargo.toml
View file

@ -1,6 +1,6 @@
[package]
name = "pay-respects-parser"
version = "0.3.2"
version = "0.3.3"
edition = "2021"
# for crates.io

4
rules.md
View file

@ -1,10 +1,10 @@
# Writing Rules
Rule files placed under [rules](./rules) in the project directory are parsed at compilation, everything is parsed to Rust code before compiling. You don't have to know the project structure nor Rust to write blazing fast rules!
Rule files placed under [rules](./core/rules) in the project directory are parsed at compilation, everything is parsed to Rust code before compiling. You don't have to know the project structure nor Rust to write blazing fast rules!
For compile-time 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/rules.rs && cargo build
touch core/src/rules.rs && cargo build
```
Runtime rules directories are searched with the following priority: