add the bitcoin (MIT?) license
[novacoin.git] / README.rst
index 7152964..df73f06 100644 (file)
@@ -14,19 +14,23 @@ 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 and models
 
-- Sending coins
+- Options dialog
 
-This has to be done:
+- Sending coins (including ask for fee when needed)
+
+- Show error messages from core
+
+- Show details dialog for transactions (on double click)
 
-- Settings are not remembered between invocations yet
+This has to be done:
 
-- Minimize to tray / Minimize on close
+- Integrate with main bitcoin tree
 
 - Start at system start
 
@@ -34,5 +38,24 @@ This has to be done:
 
 - Build on Windows
 
-- Details dialog for transactions (on double click)
+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.