1
Fork 0
mirror of https://github.com/Steffo99/todocolors.git synced 2024-10-16 07:17:28 +00:00

Add build instructions for the todored binary

This commit is contained in:
Steffo 2023-10-11 16:03:10 +02:00
parent 1d6a797373
commit 77a010a0bd

23
todored/BUILD.md Normal file
View 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`.