Mirrors/bartib
2
0
Fork 0
mirror of https://github.com/nikolassv/bartib synced 2024-11-28 14:30:25 +00:00
Code Issues Projects Releases Packages Wiki Activity

added a README file

Browse source
This commit is contained in:
Nikolas Schmidt-Voigt 2021-05-10 22:08:04 +02:00
parent d7e417a6a7
commit 2a5b41e148
1 changed files with 39 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md Normal file
View file

@ -0,0 +1,39 @@
# Bartib
Bartib is a time tracker for the command line. It safes a journal of all tracked tasks in a plaintext file.
## Build
Build it with cargo:
```
cargo build --release
```
## The `.bartib` file
Bartib safes a journal of all tracked tasks in a plaintext file. The file can either be specified via the `-f / --file` cli option or as a `BARTIB_FILE` environment variable.
## Commands
### Help
Print help informations:
```
bartib -h
```
### Start a new task
Start a new task with a short description and an associated project:
```
bartib start -p "The name of the associated project" -d "A description of the task"
```
### List all currently tracked tasks
```
bartib current
```