mirror of
https://github.com/Steffo99/todocolors.git
synced 2024-11-22 08:14:18 +00:00
Add build instructions for the todored
binary
This commit is contained in:
parent
1d6a797373
commit
77a010a0bd
1 changed files with 23 additions and 0 deletions
23
todored/BUILD.md
Normal file
23
todored/BUILD.md
Normal file
|
@ -0,0 +1,23 @@
|
||||||
|
# Build instructions
|
||||||
|
|
||||||
|
## Building the binary
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
|
To build the `todored` crate, the following must be installed on your local machine:
|
||||||
|
|
||||||
|
- [Rust](https://www.rust-lang.org/)
|
||||||
|
- rustc (stable)
|
||||||
|
- cargo
|
||||||
|
|
||||||
|
### Build
|
||||||
|
|
||||||
|
To begin compilation, run the following cargo command:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ cargo build --release
|
||||||
|
```
|
||||||
|
|
||||||
|
### Artifacts
|
||||||
|
|
||||||
|
The built executable will be available in `target/release/todored`.
|
Loading…
Reference in a new issue