add readme

This commit is contained in:
Abraham Toriz 2021-06-27 23:20:37 -05:00
parent 2ebe0a40a4
commit 208928cb65
No known key found for this signature in database
GPG Key ID: D5B4A746DB5DD42A
1 changed files with 23 additions and 0 deletions

23
README.md Normal file
View File

@ -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.