Merge pull request 'doku' (#10) from gcrkrause/doku into master
Reviewed-on: https://git.soundship.de/gcrkrause/gott/pulls/10main
commit
efbe0a89f3
21
README.md
21
README.md
|
@ -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
|
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! ;)
|
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`.
|
||||||
|
|
Loading…
Reference in New Issue