gcrkrause
/
gott
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request 'doku' (#10) from gcrkrause/doku into master 

Reviewed-on: https://git.soundship.de/gcrkrause/gott/pulls/10
main
Georg Krause 2020-02-01 13:42:02 +00:00
parent 667b01c70b 10a9ae0b59
commit efbe0a89f3
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -4,3 +4,24 @@ Meet Gott! This is a simple time tracking tool in Go. Its currently work in prog
The aim is to create a tool which allows timetracking from command line, syncs between devices, probably with a nice
web interface later on (fuck you Mite! ;)
## Setup
You need to have `go` installed on your system.
```
go get git.soundship.de/gcrkrause/gott
cd $(go env GOPATH)/src/git.soundship.de/gcrkrause/gott
go build
go install
```
No the binary lives in `$GOPATH/bin`. Make sure, this is in your `$PATH`.
## Usage
The basic idea is to tell gott when you start and stop a task. In both cases you can specify tags which get added. So you can decide what fits better to your workflow.
For example if you start coding now, type `gott start coding`. When you stop you know what you did and can give some additional info: `gott stop "implement xyz"`. Please note: When a tag should contain a whitespace, which is totally fine, put the string in double quotes.
To view your records, simply use `gott list`.