blob: ea0d3ef7f0dbe488a7cadb73a796eb502ec5f824 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
# {{project-name}}
`{{project-name}}` {{project-description}}
## Why
## Features
- Feature 1
- Feature 2
- Feature 3
## Requirements
- Rust toolchain (Rust 1.89 or newer recommended)
To install Rust:
```sh
curl https://sh.rustup.rs -sSf | sh
```
Verify installation:
```sh
rustc --version
cargo --version
```
## Building
Clone the repository and build the binary:
```sh
git clone ssh://anon@ijanc.org/{{project-name}}
cd {{project-name}}
cargo build --release
```
The binary will be located at:
```
target/release/{{project-name}}
```
You can add it to your PATH, move it to `/usr/local/bin`.
or
```
cargo install --path .
```
## Command Overview
`{{project-name}}` currently supports one primary operation:
### Command 1
## Logging and verbosity
`{{project-name}}` uses `tracing` for structured logging.
By default, logs are shown at the INFO level.\
Use `-v` to enable DEBUG logs:
```
{{project-name}} -v ...
```
Or configure via `RUST_LOG`:
```
RUST_LOG=debug {{project-name}} ...
```
## License
This project is licensed under the ISC license ([LICENSE](LICENSE) or\
http://opensource.org/licenses/ISC)
|