# HG changeset patch # User telesto # Date 1418679473 -3600 # Mon Dec 15 22:37:53 2014 +0100 # Node ID a6ac7c9cf6b037e662d35fcb99e25b26ceb77d89 # Parent 83225e5b3ab45df9085c7edcbe107133c20cdbc4 improved README.md diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ hackurist ========= -[hackurist](https://bitbucket.com/telesto/hackurist) is made up of a client library and a client command line program to access a running [dfhack](https://github.com/DFHack/dfhack) rpc server. It is written in [Go](http://golang.org/). +[hackurist](https://bitbucket.com/telesto/hackurist) is a client library/command line program to access a running [dfhack](https://github.com/DFHack/dfhack) rpc server. It is written in [Go](http://golang.org/). News ---- @@ -13,6 +13,10 @@ API Documentation: http://godoc.org/bitbucket.org/telesto/hackurist +See +[bitbucket.org/telesto/hackurist/cmd/hackurist/main.go] (https://bitbucket.org/telesto/hackurist/src/0d46764b30bb877b86d45959dc0be5e1771d164e/cmd/hackurist/main.go?at=default) +as an example on how to use this library. + command line tool ----------------- @@ -22,13 +26,22 @@ go get bitbucket.org/telesto/hackurist/cmd/hackurist -Download: +or download the binary: +[Linux (x86)](http://laokoon.in-berlin.de/~heiko/hackurist/1.0/linux/hackurist), +[Mac OS X](http://laokoon.in-berlin.de/~heiko/hackurist/1.0/osx/hackurist) +[Windows](http://laokoon.in-berlin.de/~heiko/hackurist/1.0/windows/hackurist.exe) Usage: See hackurist -h + +Some examples: -Discussion/Contact ------------------- -todo + hackurist help + ./hackurist -a :5001 region-pops list + hackurist -d lua "print(df.global.world.units.all[0].name.first_name)" + +Feedback/Contact +---------------- +There is an [anouncement topic](http://www.bay12forums.com/smf/index.php?board=29.0) at the official dwarf fortress forums. you can contact me by sending a pm.