From f8000a1e98a23940701f86e97b6bd06a473e2224 Mon Sep 17 00:00:00 2001 From: sebastianhaberey Date: Sun, 14 Apr 2013 20:07:12 +0300 Subject: [PATCH] Update README.md --- README.md | 37 ++++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4c3ccc6..901be49 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,39 @@ goxgui ====== -Bitcoin trading tool for MtGox \ No newline at end of file +About +----- + +goxgui is a Qt front end for [prof7bit's goxtool](http://prof7bit.github.io/goxtool/). This is what it looks like: + +![Screenshot](https://raw.github.com/sebastianhaberey/goxgui/master/screenshot.png) + +goxgui currently has the following features: + +* Display asks / bids +* Display MtGox account balance (USD/BTC) +* Display MtGox lag +* Place and cancel orders (USD) + +Prerequisites +------------- + +I have tested the application on **OSX 10.7.5** and **Windows XP** within the following confguration. Other setups may or may not work. + +- Python 2.7.3 +- Qt 4.8.2 +- PyQt (matching the above Python / Qt versions) +- pycrypto 2.6 + +Installation +------------ + + git clone git@github.com:sebastianhaberey/goxgui.git + cd goxgui/run + chmod 755 ./start.sh + ./start.sh + +Disclaimer +---------- + +This software is provided “as is," and you use the software at your own risk.