"Receive coins" instead of "Receiving addresses"
[novacoin.git] / README.rst
index eb209ce..9d7ad10 100644 (file)
@@ -2,7 +2,8 @@ Bitcoin-qt: Qt4 based GUI replacement for Bitcoin
 =================================================
 
 **Warning** **Warning** **Warning**
-Pre-alpha stuff! Use on testnet only!
+
+Pre-alpha stuff! I'm using this client myself on the production network, and I haven't noticed any glitches, but remember: always backup your wallet! Testing on the testnet is recommended.
 
 This has been implemented:
 
@@ -20,13 +21,17 @@ This has been implemented:
 
 - 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,8 +39,39 @@ This has to be done:
 
 - Build on Windows
 
-- Show 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-qt.pro` file.
+
+An executable named `bitcoin-qt` will be built.
+
+Berkely DB version warning
+==========================
+
+A warning for people using the *static binary* version of Bitcoin (tl;dr: **Berkely DB databases are not forward compatible**).
+
+The static binary version of Bitcoin is linked against libdb4.7 or libdb4.8 (see also `this Debian issue`_).
+
+Now the nasty thing is that databases from 5.X are not compatible with 4.X. 
 
-- Display error messages/alerts from core
+If the globally installed development package of Berkely DB installed on your system is 5.X, any source you
+build yourself will be linked against that. The first time you run with a 5.X version the database will be upgraded, 
+and 4.X cannot open the new format. This means that you cannot go back to the old statically linked version without
+significant hassle!
 
-- More thorough testing of the view with all the kinds of transactions (sendmany, generation)
+.. _`this Debian issue`: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=621425