Skip to content

Commit

Permalink
added LICENSE and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Mathias Nestler committed Apr 6, 2015
1 parent f6b756a commit 0df7ce3
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
CSFML*
SFML*
resources/
godown
6 changes: 6 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
----------------------------------------------------------------------------
"THE BEER-WARE LICENSE" (Revision 42):
<[email protected]> wrote this file. As long as you retain this notice you
can do whatever you want with this stuff. If we meet some day, and you think
this stuff is worth it, you can buy me a beer in return Mathias Nestler
----------------------------------------------------------------------------
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# godown

A talking countdown written in golang.

### Installation
Install from source with `go get github.com/MMore/godown`

### Usage
`godown [<flags>] <duration>`

Flags:
* --female male or female voice
* --lang=en english (en) or german (de) language

Args:
* <duration> duration of the countdown (i.e. 1m30s)

### License
[LICENSE](LICENSE)

## Copyright and License

Made by Mathias Nestler (c) 2015. Feel free to contribute!
Sounds Copyright Epic games (Unreal Tournament 2004)
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ func onTick(c chan FullTime, lang string, female bool) {

var (
app = kingpin.New("godown", "A talking countdown command-line application.")
duration = app.Arg("duration", "duration of the countdown (i.e. 1m30s").Required().Duration()
duration = app.Arg("duration", "duration of the countdown (i.e. 1m30s)").Required().Duration()
female = app.Flag("female", "male or female voice").Bool()
language = app.Flag("lang", "english (en) or german (de) language").Default("en").Enum("en", "de")
)
Expand Down

0 comments on commit 0df7ce3

Please sign in to comment.