README.rst

   1 Bitcoin-qt: Qt4 based GUI replacement for Bitcoin
   2 =================================================
   3
   4 **Warning** **Warning** **Warning**
   5
   6 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.
   7
   8 This has been implemented:
   9
  10 - qmake / QtCreator project (.pro)
  11
  12 - All dialogs (main GUI, address book, send coins) and menus
  13
  14 - Taskbar icon/menu
  15
  16 - GUI only functionality (copy to clipboard, select address, address/transaction filter proxys)
  17
  18 - Bitcoin core is made compatible with Qt4
  19
  20 - Send coins dialog: address and input validation
  21
  22 - Address book and transactions views and models
  23
  24 - Options dialog
  25
  26 - Sending coins (including ask for fee when needed)
  27
  28 - Show error messages from core
  29
  30 - Show details dialog for transactions (on double click)
  31
  32 This has to be done:
  33
  34 - Integrate with main bitcoin tree
  35
  36 - Start at system start
  37
  38 - Internationalization (convert WX language files)
  39
  40 - Build on Windows
  41
  42 Build instructions
  43 ===================
  44
  45 Debian
  46 -------
  47
  48 First, make sure that the required packages for Qt4 development of your
  49 distribution are installed, for Debian and Ubuntu these are:
  50
  51 ::
  52
  53     apt-get install qt4-qmake libqt4-dev build-essential libboost-dev libboost-system-dev \
  54         libboost-filesystem-dev libboost-program-options-dev libboost-thread-dev \
  55         libssl-dev libdb4.8++-dev
  56
  57 then execute the following:
  58
  59 ::
  60
  61     qmake
  62     make
  63
  64 Alternatively, install Qt Creator and open the `bitcoin-qt.pro` file.
  65
  66 An executable named `bitcoin-qt` will be built.
  67
  68
  69 Windows
  70 --------
  71
  72 Windows build instructions:
  73
  74 - Download the `QT Windows SDK`_ and install it. You don't need the Symbian stuff, just the desktop Qt.
  75
  76 - Download and extract the `dependencies archive`_  [#]_, or compile openssl, boost and dbcxx yourself.
  77
  78 - 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.
  79
  80 - Open the .pro file in QT creator and build as normal (ctrl-B)
  81
  82 .. _`QT Windows SDK`: http://qt.nokia.com/downloads/sdk-windows-cpp
  83 .. _`dependencies archive`: http://download.visucore.com/bitcoin/qtgui_deps_1.zip
  84 .. [#] PGP signature: http://download.visucore.com/bitcoin/qtgui_deps_1.zip.sig (signed with RSA key ID `610945D0`_)
  85 .. _`610945D0`: http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x610945D0
  86
  87 Berkely DB version warning
  88 ==========================
  89
  90 A warning for people using the *static binary* version of Bitcoin (tl;dr: **Berkely DB databases are not forward compatible**).
  91
  92 The static binary version of Bitcoin is linked against libdb4.7 or libdb4.8 (see also `this Debian issue`_).
  93
  94 Now the nasty thing is that databases from 5.X are not compatible with 4.X.
  95
  96 If the globally installed development package of Berkely DB installed on your system is 5.X, any source you
  97 build yourself will be linked against that. The first time you run with a 5.X version the database will be upgraded,
  98 and 4.X cannot open the new format. This means that you cannot go back to the old statically linked version without
  99 significant hassle!
 100
 101 .. _`this Debian issue`: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=621425