add the bitcoin (MIT?) license

[novacoin.git] / README.rst

diff --git a/README.rst b/README.rst
index ef33af0..df73f06 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -2,7 +2,7 @@ Bitcoin-qt: Qt4 based GUI replacement for Bitcoin
 =================================================
 
 **Warning** **Warning** **Warning**
-Pre-alpha stuff! Developer only!
+Pre-alpha stuff! Use on testnet only!
 
 This has been implemented:
 
@@ -14,20 +14,48 @@ This has been implemented:
 
 - GUI only functionality (copy to clipboard, select address, address/transaction filter proxys)
 
-- Bitcoin core is made compatible with Qt4, and linked against
+- Bitcoin core is made compatible with Qt4
 
 - Send coins dialog: address and input validation
 
-- Address book and transactions views
+- Address book and transactions views and models
+
+- Options dialog
+
+- Sending coins (including ask for fee when needed)
+
+- Show error messages from core
+
+- Show details dialog for transactions (on double click)
 
 This has to be done:
 
-- Further integration of bitcoin core, so that it can actually connect
-  to the network, send commands and get feedback
+- Integrate with main bitcoin tree
 
-- Address book and transactions models: so that 
-  something sensible is shown instead of dummy data :)
+- Start at system start
 
 - Internationalization (convert WX language files)
 
 - Build on Windows
+
+Build instructions
+===================
+
+First, make sure that the required packages for Qt4 development of your
+distribution are installed, for Debian and Ubuntu these are:
+
+::
+
+    apt-get install qt4-qmake libqt4-dev
+
+then execute the following:
+
+::
+
+    qmake
+    make
+
+Alternatively, install Qt Creator and open the `bitcoin.pro` file.
+
+An executable named `bitcoin` will be built.
+