mirror of
https://github.com/Steffo99/todocolors.git
synced 2024-11-25 17:54:18 +00:00
24 lines
408 B
Markdown
24 lines
408 B
Markdown
|
# 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`.
|