add build instructions to doc
[novacoin.git] / README.rst
1 Bitcoin-qt: Qt4 based GUI replacement for Bitcoin
2 =================================================
3
4 **Warning** **Warning** **Warning**
5 Pre-alpha stuff! Use on testnet only!
6
7 This has been implemented:
8
9 - qmake / QtCreator project (.pro)
10
11 - All dialogs (main GUI, address book, send coins) and menus
12
13 - Taskbar icon/menu
14
15 - GUI only functionality (copy to clipboard, select address, address/transaction filter proxys)
16
17 - Bitcoin core is made compatible with Qt4
18
19 - Send coins dialog: address and input validation
20
21 - Address book and transactions views and models
22
23 - Options dialog
24
25 - Sending coins (including ask for fee when needed)
26
27 - Show error messages from core
28
29 - Show details dialog for transactions (on double click)
30
31 This has to be done:
32
33 - Integrate with main bitcoin tree
34
35 - Start at system start
36
37 - Internationalization (convert WX language files)
38
39 - Build on Windows
40
41 Build instructions
42 ===================
43
44 First, make sure that the required packages for Qt4 development of your
45 distribution are installed, for Debian and Ubuntu these are:
46
47 ::
48
49     apt-get install qt4-qmake libqt4-dev
50
51 then execute the following:
52
53 ::
54
55     qmake
56     make
57
58 Alternatively, install Qt Creator and open the `bitcoin.pro` file.
59
60 An executable named `bitcoin` will be built.
61