Merge pull request #3092 from laanwj/2013_10_remove_readme_qt
doc: remove readme-qt.md
This commit is contained in:
Gavin Andresen
commit
8d3f0d099b
2 changed files with 25 additions and 103 deletions
|
|
@ -21,6 +21,9 @@ Dependencies
|
||||||
libdb4.8 Berkeley DB Blockchain & wallet storage
|
libdb4.8 Berkeley DB Blockchain & wallet storage
|
||||||
libboost Boost C++ Library
|
libboost Boost C++ Library
|
||||||
miniupnpc UPnP Support Optional firewall-jumping support
|
miniupnpc UPnP Support Optional firewall-jumping support
|
||||||
|
qt GUI GUI toolkit
|
||||||
|
protobuf Payments in GUI Data interchange format used for payment protocol
|
||||||
|
libqrencode QR codes in GUI Optional for generating QR codes
|
||||||
|
|
||||||
[miniupnpc](http://miniupnp.free.fr/) may be used for UPnP port mapping. It can be downloaded from [here](
|
[miniupnpc](http://miniupnp.free.fr/) may be used for UPnP port mapping. It can be downloaded from [here](
|
||||||
http://miniupnp.tuxfamily.org/files/). UPnP support is compiled in and
|
http://miniupnp.tuxfamily.org/files/). UPnP support is compiled in and
|
||||||
|
|
@ -46,21 +49,25 @@ Licenses of statically linked libraries:
|
||||||
- Berkeley DB 4.8.30.NC
|
- Berkeley DB 4.8.30.NC
|
||||||
- Boost 1.37
|
- Boost 1.37
|
||||||
- miniupnpc 1.6
|
- miniupnpc 1.6
|
||||||
|
- qt 4.8.3
|
||||||
|
- protobuf 2.5.0
|
||||||
|
- libqrencode 3.2.0
|
||||||
|
|
||||||
Dependency Build Instructions: Ubuntu & Debian
|
Dependency Build Instructions: Ubuntu & Debian
|
||||||
----------------------------------------------
|
----------------------------------------------
|
||||||
Build requirements:
|
Build requirements:
|
||||||
|
|
||||||
sudo apt-get install build-essential
|
sudo apt-get install build-essential
|
||||||
|
sudo apt-get install libtool autotools-dev
|
||||||
sudo apt-get install libssl-dev
|
sudo apt-get install libssl-dev
|
||||||
|
|
||||||
for Ubuntu 12.04:
|
for Ubuntu 12.04 and later:
|
||||||
|
|
||||||
sudo apt-get install libboost-all-dev
|
sudo apt-get install libboost-all-dev
|
||||||
|
|
||||||
db4.8 packages are available [here](https://launchpad.net/~bitcoin/+archive/bitcoin).
|
db4.8 packages are available [here](https://launchpad.net/~bitcoin/+archive/bitcoin).
|
||||||
|
|
||||||
Ubuntu precise has packages for libdb5.1-dev and libdb5.1++-dev,
|
Ubuntu 12.04 and later have packages for libdb5.1-dev and libdb5.1++-dev,
|
||||||
but using these will break binary wallet compatibility, and is not recommended.
|
but using these will break binary wallet compatibility, and is not recommended.
|
||||||
|
|
||||||
for other Ubuntu & Debian:
|
for other Ubuntu & Debian:
|
||||||
|
|
@ -74,6 +81,22 @@ Optional:
|
||||||
|
|
||||||
sudo apt-get install libminiupnpc-dev (see --with-miniupnpc and --enable-upnp-default)
|
sudo apt-get install libminiupnpc-dev (see --with-miniupnpc and --enable-upnp-default)
|
||||||
|
|
||||||
|
Dependencies for the GUI: Ubuntu & Debian
|
||||||
|
-----------------------------------------
|
||||||
|
|
||||||
|
If you want to build Bitcoin-Qt, make sure that the required packages for Qt development
|
||||||
|
are installed. Qt 4 is currently necessary to build the GUI.
|
||||||
|
|
||||||
|
To build with Qt 4 you need the following:
|
||||||
|
|
||||||
|
apt-get install libqt4-dev libprotobuf-dev
|
||||||
|
|
||||||
|
libqrencode (optional) can be installed with:
|
||||||
|
|
||||||
|
apt-get install libqrencode-dev
|
||||||
|
|
||||||
|
Once these are installed, they will be found by configure and a bitcoin-qt executable will be
|
||||||
|
built by default.
|
||||||
|
|
||||||
Notes
|
Notes
|
||||||
-----
|
-----
|
||||||
|
|
|
||||||
101
doc/readme-qt.md
101
doc/readme-qt.md
|
|
@ -1,101 +0,0 @@
|
||||||
Bitcoin-Qt Readme
|
|
||||||
===============================
|
|
||||||
Contains build and configuration instructions for Bitcoin-Qt (Qt4 GUI for Bitcoin).
|
|
||||||
|
|
||||||
Build Instructions
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
### Debian
|
|
||||||
|
|
||||||
|
|
||||||
First, make sure that the required packages for Qt4 development of your
|
|
||||||
distribution are installed, these are
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
for Debian and Ubuntu <= 11.10 :
|
|
||||||
|
|
||||||
|
|
||||||
apt-get install qt4-qmake libqt4-dev build-essential libboost-dev libboost-system-dev \
|
|
||||||
libboost-filesystem-dev libboost-program-options-dev libboost-thread-dev \
|
|
||||||
libssl-dev libdb4.8++-dev libprotobuf-dev protobuf-compiler
|
|
||||||
|
|
||||||
for Ubuntu >= 12.04 (please read the 'Berkely DB version warning' below):
|
|
||||||
|
|
||||||
apt-get install qt4-qmake libqt4-dev build-essential libboost-dev libboost-system-dev \
|
|
||||||
libboost-filesystem-dev libboost-program-options-dev libboost-thread-dev \
|
|
||||||
libssl-dev libdb++-dev libminiupnpc-dev libprotobuf-dev protobuf-compiler
|
|
||||||
|
|
||||||
For Qt 5 you need the following, otherwise you get an error with lrelease when running qmake:
|
|
||||||
|
|
||||||
|
|
||||||
apt-get install qt5-qmake libqt5gui5 libqt5core5 libqt5dbus5 qttools5-dev-tools
|
|
||||||
|
|
||||||
Once these are installed, they will be found by configure and bitcoin-qt will be
|
|
||||||
built by default.
|
|
||||||
|
|
||||||
|
|
||||||
### Mac OS X
|
|
||||||
|
|
||||||
* Download and install the [Qt Mac OS X SDK](https://qt-project.org/downloads). It is recommended to also install Apple's Xcode with UNIX tools.
|
|
||||||
* Download and install either [MacPorts](https://www.macports.org/) or [HomeBrew](http://mxcl.github.io/homebrew/).
|
|
||||||
* Execute the following commands in a terminal to get the dependencies using MacPorts
|
|
||||||
|
|
||||||
sudo port selfupdate
|
|
||||||
sudo port install boost db48 miniupnpc protobuf-cpp
|
|
||||||
|
|
||||||
* Execute the following commands in a terminal to get the dependencies using HomeBrew:
|
|
||||||
|
|
||||||
brew update
|
|
||||||
brew install boost miniupnpc openssl berkeley-db4 protobuf
|
|
||||||
|
|
||||||
Build Configuration Options
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
### UPnP port forwarding
|
|
||||||
|
|
||||||
UPnP support is compiled in when possible and turned off by default. See the
|
|
||||||
configure options for upnp behavior desired:
|
|
||||||
|
|
||||||
--with-miniupnpc No UPnP support miniupnp not required
|
|
||||||
--disable-upnp-default (the default) UPnP support turned off by default at runtime
|
|
||||||
--enable-upnp-default UPnP support turned on by default at runtime
|
|
||||||
|
|
||||||
### Notification support for recent (k)ubuntu versions
|
|
||||||
|
|
||||||
DBUS support is enabled by default if dependencies are met.
|
|
||||||
|
|
||||||
See the --with-qtdbus configure option.
|
|
||||||
|
|
||||||
### Generation of QR codes
|
|
||||||
|
|
||||||
[libqrencode](http://fukuchi.org/works/qrencode/) may be used to generate QRCode images for payment requests.
|
|
||||||
|
|
||||||
QR code support is enabled by default if dependencies are met.
|
|
||||||
|
|
||||||
See the --with-qrencode configure option.
|
|
||||||
|
|
||||||
Warnings
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
### Berkely DB Version Warning
|
|
||||||
|
|
||||||
|
|
||||||
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.8 (see also [this Debian issue](http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=621425)).
|
|
||||||
|
|
||||||
Now the nasty thing is that databases from 5.X are not compatible with 4.X.
|
|
||||||
|
|
||||||
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!
|
|
||||||
|
|
||||||
### Ubuntu 11.10 Warning
|
|
||||||
|
|
||||||
|
|
||||||
Ubuntu 11.10 has a package called 'qt-at-spi' installed by default. At the time of writing, having that package installed causes bitcoin-qt to crash intermittently. The issue has been reported as [launchpad bug 857790](https://bugs.launchpad.net/ubuntu/+source/qt-at-spi/+bug/857790), but
|
|
||||||
isn't yet fixed.
|
|
||||||
|
|
||||||
Until the bug is fixed, you can remove the qt-at-spi package to work around the problem, though this will presumably disable screen reader functionality for Qt apps:
|
|
||||||
|
|
||||||
sudo apt-get remove qt-at-spi
|
|
||||||
|
|
||||||
Loading…
Reference in a new issue