Show unconfirmed balance on overview page
[novacoin.git] / README.rst
index 9c1db1e..9ef4576 100644 (file)
@@ -3,45 +3,44 @@ Bitcoin-qt: Qt4 based GUI replacement for Bitcoin
 
 **Warning** **Warning** **Warning**
 
-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.
+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:
 
 - qmake / QtCreator project (.pro)
 
-- All dialogs (main GUI, address book, send coins) and menus
+- Compatibility with Linux (both GNOME and KDE), MacOSX and Windows
 
-- Taskbar icon/menu
+- All functionality of the original client, including taskbar icon/menu
 
-- GUI only functionality (copy to clipboard, select address, address/transaction filter proxys)
+- Tabbed interface
 
-- Bitcoin core is made compatible with Qt4
+- Overview page with current balance, unconfirmed balance, etc
 
-- Send coins dialog: address and input validation
+- User friendly transaction list with status icons, real-time filtering and a context menu that allows editing and copying labels
 
-- Address book and transactions views and models
+- Asks for confirmation before sending coins
 
-- Options dialog
+- CSV export of transactions and address book
 
-- Sending coins (including ask for fee when needed)
+- Shows alternative icon when connected to testnet
 
-- Show error messages from core
-
-- Show details dialog for transactions (on double click)
+- Progress bar on initial block download
 
 This has to be done:
 
-- Integrate with main bitcoin tree
-
 - Start at system start
 
 - Internationalization (convert WX language files)
 
-- Build on Windows
 
-Build instructions
+Build instructions 
 ===================
 
+Debian
+-------
+
 First, make sure that the required packages for Qt4 development of your
 distribution are installed, for Debian and Ubuntu these are:
 
@@ -62,10 +61,29 @@ Alternatively, install Qt Creator and open the `bitcoin-qt.pro` file.
 
 An executable named `bitcoin-qt` will be built.
 
+
+Windows
+--------
+
+Windows build instructions:
+
+- Download the `QT Windows SDK`_ and install it. You don't need the Symbian stuff, just the desktop Qt.
+
+- Download and extract the `dependencies archive`_  [#]_, or compile openssl, boost and dbcxx yourself.
+
+- Copy the contents of the folder "deps" to "X:\QtSDK\mingw", replace X:\ with the location where you installed the Qt SDK. Make sure that the contents of "deps/include" end up in the current "include" directory and such.
+
+- Open the .pro file in QT creator and build as normal (ctrl-B)
+
+.. _`QT Windows SDK`: http://qt.nokia.com/downloads/sdk-windows-cpp
+.. _`dependencies archive`: http://download.visucore.com/bitcoin/qtgui_deps_1.zip
+.. [#] PGP signature: http://download.visucore.com/bitcoin/qtgui_deps_1.zip.sig (signed with RSA key ID `610945D0`_)
+.. _`610945D0`: http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x610945D0
+
 Berkely DB version warning
 ==========================
 
-A warning for people using the *static binary* version of Bitcoin (tl;dr: **Berkely DB databases are not forward compatible**).
+A warning for people using the *static binary* version of Bitcoin on a Linux/UNIX-ish system (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`_).