add readme
This commit is contained in:
parent
2ebe0a40a4
commit
208928cb65
|
@ -0,0 +1,23 @@
|
|||
# Tiempo
|
||||
|
||||
A [timetrap](https://github.com/samg/timetrap/) compatible time tracking
|
||||
command line application.
|
||||
|
||||
## How to run
|
||||
|
||||
You need [rust](https://rustup.rs), then clone the repo and simply run
|
||||
|
||||
cargo test
|
||||
|
||||
to check that everything is working, and then
|
||||
|
||||
cargo build --release
|
||||
|
||||
to have a binary at `target/release/tiempo` that you can then move to a
|
||||
directory in your `PATH`. Pro tip, alias it to `t`.
|
||||
|
||||
Run
|
||||
|
||||
tiempo --help
|
||||
|
||||
to see the options.
|
Loading…
Reference in New Issue