Browse Source

Litecoin: Documentation s/bitcoin/litecoin/

0.8
Warren Togami 11 years ago
parent
commit
ed725643ca
  1. 10
      INSTALL
  2. 42
      README.md
  3. 2
      doc/Doxyfile
  4. 17
      doc/README.md
  5. 14
      doc/README_windows.txt
  6. 24
      doc/Tor.txt
  7. 9
      doc/build-msw.md
  8. 44
      doc/build-osx.md
  9. 26
      doc/build-unix.md
  10. 2
      doc/coding.md
  11. 24
      doc/readme-qt.rst
  12. 91
      doc/release-process.md
  13. 14
      doc/unit-tests.md

10
INSTALL

@ -1,9 +1,9 @@
Building Bitcoin Building Litecoin
See doc/readme-qt.rst for instructions on building Bitcoin-Qt, See doc/readme-qt.rst for instructions on building Litecoin-Qt,
the intended-for-end-users, nice-graphical-interface, reference the intended-for-end-users, nice-graphical-interface, reference
implementation of Bitcoin. implementation of Litecoin.
See doc/build-*.txt for instructions on building bitcoind, See doc/build-*.txt for instructions on building litecoind,
the intended-for-services, no-graphical-interface, reference the intended-for-services, no-graphical-interface, reference
implementation of Bitcoin. implementation of Litecoin.

42
README.md

@ -1,26 +1,30 @@
Bitcoin integration/staging tree Litecoin integration/staging tree
================================ ================================
http://www.bitcoin.org http://www.litecoin.org
Copyright (c) 2009-2013 Bitcoin Developers Copyright (c) 2009-2013 Bitcoin Developers
Copyright (c) 2011-2013 Litecoin Developers
What is Bitcoin? What is Litecoin?
---------------- ----------------
Bitcoin is an experimental new digital currency that enables instant payments to Litecoin is a lite version of Bitcoin using scrypt as a proof-of-work algorithm.
anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate - 2.5 minute block targets
with no central authority: managing transactions and issuing money are carried - subsidy halves in 840k blocks (~4 years)
out collectively by the network. Bitcoin is also the name of the open source - ~84 million total coins
software which enables the use of this currency.
The rest is the same as Bitcoin.
- 50 coins per block
- 2016 blocks to retarget difficulty
For more information, as well as an immediately useable, binary version of For more information, as well as an immediately useable, binary version of
the Bitcoin client sofware, see http://www.bitcoin.org. the Litecoin client sofware, see http://www.litecoin.org.
License License
------- -------
Bitcoin is released under the terms of the MIT license. See `COPYING` for more Litecoin is released under the terms of the MIT license. See `COPYING` for more
information or see http://opensource.org/licenses/MIT. information or see http://opensource.org/licenses/MIT.
Development process Development process
@ -29,7 +33,7 @@ Development process
Developers work in their own trees, then submit pull requests when they think Developers work in their own trees, then submit pull requests when they think
their feature or bug fix is ready. their feature or bug fix is ready.
If it is a simple/trivial/non-controversial change, then one of the Bitcoin If it is a simple/trivial/non-controversial change, then one of the Litecoin
development team members simply pulls it. development team members simply pulls it.
If it is a *more complicated or potentially controversial* change, then the patch If it is a *more complicated or potentially controversial* change, then the patch
@ -43,7 +47,7 @@ controversial.
The `master` branch is regularly built and tested, but is not guaranteed to be The `master` branch is regularly built and tested, but is not guaranteed to be
completely stable. [Tags](https://github.com/bitcoin/bitcoin/tags) are created completely stable. [Tags](https://github.com/bitcoin/bitcoin/tags) are created
regularly to indicate new official, stable release versions of Bitcoin. regularly to indicate new official, stable release versions of Litecoin.
Testing Testing
------- -------
@ -66,17 +70,5 @@ Unit tests for the GUI code are in `src/qt/test/`. To compile and run them:
qmake BITCOIN_QT_TEST=1 -o Makefile.test bitcoin-qt.pro qmake BITCOIN_QT_TEST=1 -o Makefile.test bitcoin-qt.pro
make -f Makefile.test make -f Makefile.test
./bitcoin-qt_test ./litecoin-qt_test
Every pull request is built for both Windows and Linux on a dedicated server,
and unit and sanity tests are automatically run. The binaries produced may be
used for manual QA testing — a link to them will appear in a comment on the
pull request posted by [BitcoinPullTester](https://github.com/BitcoinPullTester). See https://github.com/TheBlueMatt/test-scripts
for the build/test scripts.
### Manual Quality Assurance (QA) Testing
Large changes should have a test plan, and should be tested by somebody other
than the developer who wrote the code.
See https://github.com/bitcoin/QA/ for how to create a test plan.

2
doc/Doxyfile

@ -28,7 +28,7 @@ DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project. # by quotes) that should identify the project.
PROJECT_NAME = Bitcoin PROJECT_NAME = Litecoin
# The PROJECT_NUMBER tag can be used to enter a project or revision number. # The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or # This could be handy for archiving the generated documentation or

17
doc/README.md

@ -1,7 +1,8 @@
Bitcoin 0.8.3 BETA Litecoin 0.8.3 BETA
==================== ====================
Copyright (c) 2009-2013 Bitcoin Developers Copyright (c) 2009-2013 Bitcoin Developers
Copyright (c) 2011-2013 Litecoin Developers
Distributed under the MIT/X11 software license, see the accompanying Distributed under the MIT/X11 software license, see the accompanying
file COPYING or http://www.opensource.org/licenses/mit-license.php. file COPYING or http://www.opensource.org/licenses/mit-license.php.
@ -11,7 +12,7 @@ cryptographic software written by Eric Young ([eay@cryptsoft.com](mailto:eay@cry
Intro Intro
--------------------- ---------------------
Bitcoin is a free open source peer-to-peer electronic cash system that is Litecoin is a free open source peer-to-peer electronic cash system that is
completely decentralized, without the need for a central server or trusted completely decentralized, without the need for a central server or trusted
parties. Users hold the crypto keys to their own money and transact directly parties. Users hold the crypto keys to their own money and transact directly
with each other, with the help of a P2P network to check for double-spending. with each other, with the help of a P2P network to check for double-spending.
@ -19,17 +20,17 @@ with each other, with the help of a P2P network to check for double-spending.
Setup Setup
--------------------- ---------------------
You need the Qt4 run-time libraries to run Bitcoin-Qt. On Debian or Ubuntu: You need the Qt4 run-time libraries to run Litecoin-Qt. On Debian or Ubuntu:
`sudo apt-get install libqtgui4` `sudo apt-get install libqtgui4`
Unpack the files into a directory and run: Unpack the files into a directory and run:
- bin/32/bitcoin-qt (GUI, 32-bit) - bin/32/litecoin-qt (GUI, 32-bit)
- bin/32/bitcoind (headless, 32-bit) - bin/32/litecoind (headless, 32-bit)
- bin/64/bitcoin-qt (GUI, 64-bit) - bin/64/litecoin-qt (GUI, 64-bit)
- bin/64/bitcoind (headless, 64-bit) - bin/64/litecoind (headless, 64-bit)
See the documentation at the [Bitcoin Wiki](https://en.bitcoin.it/wiki/Main_Page) See the documentation at the [Litecoin Wiki](http://litecoin.info)
for help and more information. for help and more information.

14
doc/README_windows.txt

@ -1,6 +1,7 @@
Bitcoin 0.8.3 BETA Litecoin 0.8.3 BETA
Copyright (c) 2009-2013 Bitcoin Developers Copyright (c) 2009-2013 Bitcoin Developers
Copyright (c) 2011-2013 Litecoin Developers
Distributed under the MIT/X11 software license, see the accompanying Distributed under the MIT/X11 software license, see the accompanying
file COPYING or http://www.opensource.org/licenses/mit-license.php. file COPYING or http://www.opensource.org/licenses/mit-license.php.
This product includes software developed by the OpenSSL Project for use in This product includes software developed by the OpenSSL Project for use in
@ -10,7 +11,7 @@ cryptographic software written by Eric Young (eay@cryptsoft.com).
Intro Intro
----- -----
Bitcoin is a free open source peer-to-peer electronic cash system that is Litecoin is a free open source peer-to-peer electronic cash system that is
completely decentralized, without the need for a central server or trusted completely decentralized, without the need for a central server or trusted
parties. Users hold the crypto keys to their own money and transact directly parties. Users hold the crypto keys to their own money and transact directly
with each other, with the help of a P2P network to check for double-spending. with each other, with the help of a P2P network to check for double-spending.
@ -18,13 +19,10 @@ with each other, with the help of a P2P network to check for double-spending.
Setup Setup
----- -----
Unpack the files into a directory and run bitcoin-qt.exe. Unpack the files into a directory and run litecoin-qt.exe.
Bitcoin-Qt is the original Bitcoin client and it builds the backbone of the network. Litecoin-Qt is the original Litecoin client and it builds the backbone of the network.
However, it downloads and stores the entire history of Bitcoin transactions; However, it downloads and stores the entire history of Litecoin transactions;
depending on the speed of your computer and network connection, the synchronization depending on the speed of your computer and network connection, the synchronization
process can take anywhere from a few hours to a day or more. process can take anywhere from a few hours to a day or more.
See the bitcoin wiki at:
https://en.bitcoin.it/wiki/Main_Page
for more help and information.

24
doc/Tor.txt

@ -1,7 +1,7 @@
TOR SUPPORT IN BITCOIN TOR SUPPORT IN BITCOIN
====================== ======================
It is possible to run Bitcoin as a Tor hidden service, and connect to such services. It is possible to run Litecoin as a Tor hidden service, and connect to such services.
The following directions assume you have a Tor proxy running on port 9050. Many distributions The following directions assume you have a Tor proxy running on port 9050. Many distributions
default to having a SOCKS proxy listening on port 9050, but others may not. default to having a SOCKS proxy listening on port 9050, but others may not.
@ -10,10 +10,10 @@ https://www.torproject.org/docs/faq.html.en#TBBSocksPort for how to properly
configure Tor. configure Tor.
1. Run bitcoin behind a Tor proxy 1. Run litecoin behind a Tor proxy
--------------------------------- ---------------------------------
The first step is running Bitcoin behind a Tor proxy. This will already make all The first step is running Litecoin behind a Tor proxy. This will already make all
outgoing connections be anonimized, but more is possible. outgoing connections be anonimized, but more is possible.
-socks=5 SOCKS5 supports connecting-to-hostname, which can be used instead -socks=5 SOCKS5 supports connecting-to-hostname, which can be used instead
@ -39,26 +39,26 @@ outgoing connections be anonimized, but more is possible.
In a typical situation, this suffices to run behind a Tor proxy: In a typical situation, this suffices to run behind a Tor proxy:
./bitcoin -proxy=127.0.0.1:9050 ./litecoind -proxy=127.0.0.1:9050
2. Run a bitcoin hidden server 2. Run a litecoin hidden server
------------------------------ ------------------------------
If you configure your Tor system accordingly, it is possible to make your node also If you configure your Tor system accordingly, it is possible to make your node also
reachable from the Tor network. Add these lines to your /etc/tor/torrc (or equivalent reachable from the Tor network. Add these lines to your /etc/tor/torrc (or equivalent
config file): config file):
HiddenServiceDir /var/lib/tor/bitcoin-service/ HiddenServiceDir /var/lib/tor/litecoin-service/
HiddenServicePort 9333 127.0.0.1:9333 HiddenServicePort 9333 127.0.0.1:9333
The directory can be different of course, but (both) port numbers should be equal to The directory can be different of course, but (both) port numbers should be equal to
your bitcoind's P2P listen port (9333 by default). your litecoind's P2P listen port (9333 by default).
-externalip=X You can tell bitcoin about its publicly reachable address using -externalip=X You can tell litecoin about its publicly reachable address using
this option, and this can be a .onion address. Given the above this option, and this can be a .onion address. Given the above
configuration, you can find your onion address in configuration, you can find your onion address in
/var/lib/tor/bitcoin-service/hostname. Onion addresses are given /var/lib/tor/litecoin-service/hostname. Onion addresses are given
preference for your node to advertize itself with, for connections preference for your node to advertize itself with, for connections
coming from unroutable addresses (such as 127.0.0.1, where the coming from unroutable addresses (such as 127.0.0.1, where the
Tor proxy typically runs). Tor proxy typically runs).
@ -75,18 +75,18 @@ your bitcoind's P2P listen port (9333 by default).
In a typical situation, where you're only reachable via Tor, this should suffice: In a typical situation, where you're only reachable via Tor, this should suffice:
./bitcoind -proxy=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -listen ./litecoind -proxy=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -listen
(obviously, replace the Onion address with your own). If you don't care too much (obviously, replace the Onion address with your own). If you don't care too much
about hiding your node, and want to be reachable on IPv4 as well, additionally about hiding your node, and want to be reachable on IPv4 as well, additionally
specify: specify:
./bitcoind ... -discover ./litecoind ... -discover
and open port 9333 on your firewall (or use -upnp). and open port 9333 on your firewall (or use -upnp).
If you only want to use Tor to reach onion addresses, but not use it as a proxy If you only want to use Tor to reach onion addresses, but not use it as a proxy
for normal IPv4/IPv6 communication, use: for normal IPv4/IPv6 communication, use:
./bitcoin -tor=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -discover ./litecoind -tor=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -discover

9
doc/build-msw.md

@ -1,12 +1,11 @@
Copyright (c) 2009-2013 Bitcoin Developers Copyright (c) 2009-2013 Bitcoin Developers
Distributed under the MIT/X11 software license, see the accompanying Distributed under the MIT/X11 software license, see the accompanying
file COPYING or http://www.opensource.org/licenses/mit-license.php. file COPYING or http://www.opensource.org/licenses/mit-license.php.
This product includes software developed by the OpenSSL Project for use in the [OpenSSL Toolkit](http://www.openssl.org/). This product includes This product includes software developed by the OpenSSL Project for use in the [OpenSSL Toolkit](http://www.openssl.org/). This product includes
cryptographic software written by Eric Young ([eay@cryptsoft.com](mailto:eay@cryptsoft.com)), and UPnP software written by Thomas Bernard. cryptographic software written by Eric Young ([eay@cryptsoft.com](mailto:eay@cryptsoft.com)), and UPnP software written by Thomas Bernard.
See readme-qt.rst for instructions on building Bitcoin-Qt, the See readme-qt.rst for instructions on building Litecoin-Qt, the
graphical user interface. graphical user interface.
WINDOWS BUILD NOTES WINDOWS BUILD NOTES
@ -81,10 +80,10 @@ MSYS shell:
mkdir miniupnpc mkdir miniupnpc
cp *.h miniupnpc/ cp *.h miniupnpc/
Bitcoin Litecoin
------- -------
DOS prompt: DOS prompt:
cd \bitcoin\src cd \litecoin\src
mingw32-make -f makefile.mingw mingw32-make -f makefile.mingw
strip bitcoind.exe strip litecoind.exe

44
doc/build-osx.md

@ -1,4 +1,4 @@
Mac OS X bitcoind build instructions Mac OS X litecoind build instructions
==================================== ====================================
Authors Authors
@ -26,7 +26,7 @@ Eric Young (eay@cryptsoft.com) and UPnP software written by Thomas Bernard.
Notes Notes
----- -----
See `doc/readme-qt.rst` for instructions on building Bitcoin-Qt, the See `doc/readme-qt.rst` for instructions on building Litecoin-Qt, the
graphical user interface. graphical user interface.
Tested on OS X 10.5 through 10.8 on Intel processors only. PPC is not Tested on OS X 10.5 through 10.8 on Intel processors only. PPC is not
@ -72,14 +72,14 @@ Installing the dependencies using MacPorts is very straightforward.
sudo port install boost db48@+no_java openssl miniupnpc sudo port install boost db48@+no_java openssl miniupnpc
### Building `bitcoind` ### Building `litecoind`
1. Clone the github tree to get the source code and go into the directory. 1. Clone the github tree to get the source code and go into the directory.
git clone git@github.com:bitcoin/bitcoin.git bitcoin git clone git@github.com:litecoin-project/litecoin.git litecoin
cd bitcoin cd litecoin
2. Build bitcoind: 2. Build litecoind:
cd src cd src
make -f makefile.osx make -f makefile.osx
@ -107,12 +107,12 @@ If not, you can ensure that the Brew OpenSSL is correctly linked by running
Rerunning "openssl version" should now return the correct version. Rerunning "openssl version" should now return the correct version.
### Building `bitcoind` ### Building `litecoind`
1. Clone the github tree to get the source code and go into the directory. 1. Clone the github tree to get the source code and go into the directory.
git clone git@github.com:bitcoin/bitcoin.git bitcoin git clone git@github.com:litecoin-project/litecoin.git litecoin
cd bitcoin cd litecoin
2. Modify source in order to pick up the `openssl` library. 2. Modify source in order to pick up the `openssl` library.
@ -122,7 +122,7 @@ Rerunning "openssl version" should now return the correct version.
patch -p1 < contrib/homebrew/makefile.osx.patch patch -p1 < contrib/homebrew/makefile.osx.patch
3. Build bitcoind: 3. Build litecoind:
cd src cd src
make -f makefile.osx make -f makefile.osx
@ -134,10 +134,10 @@ Rerunning "openssl version" should now return the correct version.
Creating a release build Creating a release build
------------------------ ------------------------
A bitcoind binary is not included in the Bitcoin-Qt.app bundle. You can ignore A litecoind binary is not included in the Litecoin-Qt.app bundle. You can ignore
this section if you are building `bitcoind` for your own use. this section if you are building `litecoind` for your own use.
If you are building `bitcoind` for others, your build machine should be set up If you are building `litecond` for others, your build machine should be set up
as follows for maximum compatibility: as follows for maximum compatibility:
All dependencies should be compiled with these flags: All dependencies should be compiled with these flags:
@ -156,30 +156,30 @@ As of December 2012, the `boost` port does not obey `macosx_deployment_target`.
Download `http://gavinandresen-bitcoin.s3.amazonaws.com/boost_macports_fix.zip` Download `http://gavinandresen-bitcoin.s3.amazonaws.com/boost_macports_fix.zip`
for a fix. Some ports also seem to obey either `build_arch` or for a fix. Some ports also seem to obey either `build_arch` or
`macosx_deployment_target`, but not both at the same time. For example, building `macosx_deployment_target`, but not both at the same time. For example, building
on an OS X 10.6 64-bit machine fails. Official release builds of Bitcoin-Qt are on an OS X 10.6 64-bit machine fails. Official release builds of Litecoin-Qt are
compiled on an OS X 10.6 32-bit machine to workaround that problem. compiled on an OS X 10.6 32-bit machine to workaround that problem.
Once dependencies are compiled, creating `Bitcoin-Qt.app` is easy: Once dependencies are compiled, creating `Litecoin-Qt.app` is easy:
make -f Makefile.osx RELEASE=1 make -f Makefile.osx RELEASE=1
Running Running
------- -------
It's now available at `./bitcoind`, provided that you are still in the `src` It's now available at `./litecoind`, provided that you are still in the `src`
directory. We have to first create the RPC configuration file, though. directory. We have to first create the RPC configuration file, though.
Run `./bitcoind` to get the filename where it should be put, or just try these Run `./litecoind` to get the filename where it should be put, or just try these
commands: commands:
echo -e "rpcuser=bitcoinrpc\nrpcpassword=$(xxd -l 16 -p /dev/urandom)" > "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf" echo -e "rpcuser=litecoinrpc\nrpcpassword=$(xxd -l 16 -p /dev/urandom)" > "/Users/${USER}/Library/Application Support/Litecoin/litecoin.conf"
chmod 600 "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf" chmod 600 "/Users/${USER}/Library/Application Support/Litecoin/litecoin.conf"
When next you run it, it will start downloading the blockchain, but it won't When next you run it, it will start downloading the blockchain, but it won't
output anything while it's doing this. This process may take several hours. output anything while it's doing this. This process may take several hours.
Other commands: Other commands:
./bitcoind --help # for a list of command-line options. ./litecoind --help # for a list of command-line options.
./bitcoind -daemon # to start the bitcoin daemon. ./litecoind -daemon # to start the litecoin daemon.
./bitcoind help # When the daemon is running, to get a list of RPC commands ./litecoind help # When the daemon is running, to get a list of RPC commands

26
doc/build-unix.md

@ -12,9 +12,9 @@ To Build
--------------------- ---------------------
cd src/ cd src/
make -f makefile.unix # Headless bitcoin make -f makefile.unix # Headless litecoin
See readme-qt.rst for instructions on building Bitcoin-Qt, the graphical user interface. See readme-qt.rst for instructions on building Litecoin-Qt, the graphical user interface.
Dependencies Dependencies
--------------------- ---------------------
@ -79,21 +79,6 @@ Optional:
sudo apt-get install libminiupnpc-dev (see USE_UPNP compile flag) sudo apt-get install libminiupnpc-dev (see USE_UPNP compile flag)
Dependency Build Instructions: Gentoo
-------------------------------------
Note: If you just want to install bitcoind on Gentoo, you can add the Bitcoin overlay and use your package manager:
layman -a bitcoin && emerge bitcoind
emerge -av1 --noreplace boost glib openssl sys-libs/db:4.8
Take the following steps to build (no UPnP support):
cd ${BITCOIN_DIR}/src
make -f makefile.unix USE_UPNP= USE_IPV6=1 BDB_INCLUDE_PATH='/usr/include/db4.8'
strip bitcoind
Notes Notes
----- -----
The release is built with GCC and then "strip bitcoind" to strip the debug The release is built with GCC and then "strip bitcoind" to strip the debug
@ -128,7 +113,7 @@ If you need to build Boost yourself:
Security Security
-------- --------
To help make your bitcoin installation more secure by making certain attacks impossible to To help make your litecoin installation more secure by making certain attacks impossible to
exploit even if a vulnerability is found, you can take the following measures: exploit even if a vulnerability is found, you can take the following measures:
* Position Independent Executable * Position Independent Executable
@ -142,12 +127,11 @@ exploit even if a vulnerability is found, you can take the following measures:
such as: "relocation R_X86_64_32 against `......' can not be used when making a shared object;" such as: "relocation R_X86_64_32 against `......' can not be used when making a shared object;"
To build with PIE, use: To build with PIE, use:
make -f makefile.unix ... -e PIE=1 make -f makefile.unix ... -e PIE=1
To test that you have built PIE executable, install scanelf, part of paxutils, and use: To test that you have built PIE executable, install scanelf, part of paxutils, and use:
scanelf -e ./bitcoin scanelf -e ./litecoin
The output should contain: The output should contain:
TYPE TYPE
@ -161,7 +145,7 @@ exploit even if a vulnerability is found, you can take the following measures:
executable without the non-executable stack protection. executable without the non-executable stack protection.
To verify that the stack is non-executable after compiling use: To verify that the stack is non-executable after compiling use:
`scanelf -e ./bitcoin` `scanelf -e ./litecoin`
the output should contain: the output should contain:
STK/REL/PTL STK/REL/PTL

2
doc/coding.md

@ -67,7 +67,7 @@ Threads
- ThreadGetMyExternalIP : Determines outside-the-firewall IP address, sends addr message to connected peers when it determines it. - ThreadGetMyExternalIP : Determines outside-the-firewall IP address, sends addr message to connected peers when it determines it.
- ThreadSocketHandler : Sends/Receives data from peers on port 9333. - ThreadSocketHandler : Sends/Receives data from peers on port 8333.
- ThreadMessageHandler : Higher-level message handling (sending and receiving). - ThreadMessageHandler : Higher-level message handling (sending and receiving).

24
doc/readme-qt.rst

@ -1,4 +1,4 @@
Bitcoin-Qt: Qt4 GUI for Bitcoin Litecoin-Qt: Qt4 GUI for Litecoin
=============================== ===============================
Build instructions Build instructions
@ -28,6 +28,12 @@ for Ubuntu >= 12.04 (please read the 'Berkely DB version warning' below):
libboost-filesystem-dev libboost-program-options-dev libboost-thread-dev \ libboost-filesystem-dev libboost-program-options-dev libboost-thread-dev \
libssl-dev libdb++-dev libminiupnpc-dev libssl-dev libdb++-dev libminiupnpc-dev
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
then execute the following: then execute the following:
:: ::
@ -35,9 +41,9 @@ then execute the following:
qmake qmake
make make
Alternatively, install `Qt Creator`_ and open the `bitcoin-qt.pro` file. Alternatively, install `Qt Creator`_ and open the `litecoin-qt.pro` file.
An executable named `bitcoin-qt` will be built. An executable named `litecoin-qt` will be built.
.. _`Qt Creator`: http://qt-project.org/downloads/ .. _`Qt Creator`: http://qt-project.org/downloads/
@ -62,11 +68,11 @@ Mac OS X
brew update brew update
brew install boost miniupnpc openssl berkeley-db4 brew install boost miniupnpc openssl berkeley-db4
- If using HomeBrew, edit `bitcoin-qt.pro` to account for library location differences. There's a diff in `contrib/homebrew/bitcoin-qt-pro.patch` that shows what you need to change, or you can just patch by doing - If using HomeBrew, edit `litecoin-qt.pro` to account for library location differences. There's a diff in `contrib/homebrew/bitcoin-qt-pro.patch` that shows what you need to change, or you can just patch by doing
patch -p1 < contrib/homebrew/bitcoin.qt.pro.patch patch -p1 < contrib/homebrew/bitcoin.qt.pro.patch
- Open the bitcoin-qt.pro file in Qt Creator and build as normal (cmd-B) - Open the litecoin-qt.pro file in Qt Creator and build as normal (cmd-B)
.. _`Qt Mac OS X SDK`: http://qt-project.org/downloads/ .. _`Qt Mac OS X SDK`: http://qt-project.org/downloads/
.. _`MacPorts`: http://www.macports.org/install.php .. _`MacPorts`: http://www.macports.org/install.php
@ -79,7 +85,7 @@ Build configuration options
UPnP port forwarding UPnP port forwarding
--------------------- ---------------------
To use UPnP for port forwarding behind a NAT router (recommended, as more connections overall allow for a faster and more stable bitcoin experience), pass the following argument to qmake: To use UPnP for port forwarding behind a NAT router (recommended, as more connections overall allow for a faster and more stable litecoin experience), pass the following argument to qmake:
:: ::
@ -127,9 +133,9 @@ flag to qmake to control this:
Berkely DB version warning 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**). A warning for people using the *static binary* version of Litecoin 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`_). The static binary version of Litecoin is linked against libdb4.8 (see also `this Debian issue`_).
Now the nasty thing is that databases from 5.X are not compatible with 4.X. Now the nasty thing is that databases from 5.X are not compatible with 4.X.
@ -144,7 +150,7 @@ 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 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`_, but installed causes litecoin-qt to crash intermittently. The issue has been reported as `launchpad bug 857790`_, but
isn't yet fixed. 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 Until the bug is fixed, you can remove the qt-at-spi package to work around the problem, though this will presumably

91
doc/release-process.md

@ -1,15 +1,12 @@
Release Process Release Process
==================== ====================
* update translations (ping wumpus, Diapolo or tcatm on IRC)
* see https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#syncing-with-transifex
* * * * * *
###update (commit) version in sources ###update (commit) version in sources
bitcoin-qt.pro litecoin-qt.pro
contrib/verifysfbinaries/verify.sh contrib/verifysfbinaries/verify.sh
doc/README* doc/README*
share/setup.nsi share/setup.nsi
@ -27,7 +24,7 @@ Release Process
##perform gitian builds ##perform gitian builds
From a directory containing the bitcoin source, gitian-builder and gitian.sigs From a directory containing the litecoin source, gitian-builder and gitian.sigs
export SIGNER=(your gitian key, ie bluematt, sipa, etc) export SIGNER=(your gitian key, ie bluematt, sipa, etc)
export VERSION=0.8.0 export VERSION=0.8.0
@ -45,54 +42,54 @@ Release Process
wget 'http://downloads.sourceforge.net/project/boost/boost/1.50.0/boost_1_50_0.tar.bz2' wget 'http://downloads.sourceforge.net/project/boost/boost/1.50.0/boost_1_50_0.tar.bz2'
wget 'http://releases.qt-project.org/qt4/source/qt-everywhere-opensource-src-4.8.3.tar.gz' wget 'http://releases.qt-project.org/qt4/source/qt-everywhere-opensource-src-4.8.3.tar.gz'
cd .. cd ..
./bin/gbuild ../bitcoin/contrib/gitian-descriptors/boost-win32.yml ./bin/gbuild ../litecoin/contrib/gitian-descriptors/boost-win32.yml
mv build/out/boost-win32-1.50.0-gitian2.zip inputs/ mv build/out/boost-win32-1.50.0-gitian2.zip inputs/
./bin/gbuild ../bitcoin/contrib/gitian-descriptors/qt-win32.yml ./bin/gbuild ../litecoin/contrib/gitian-descriptors/qt-win32.yml
mv build/out/qt-win32-4.8.3-gitian-r1.zip inputs/ mv build/out/qt-win32-4.8.3-gitian-r1.zip inputs/
./bin/gbuild ../bitcoin/contrib/gitian-descriptors/deps-win32.yml ./bin/gbuild ../litecoin/contrib/gitian-descriptors/deps-win32.yml
mv build/out/bitcoin-deps-0.0.5.zip inputs/ mv build/out/litecoin-deps-0.0.5.zip inputs/
Build bitcoind and bitcoin-qt on Linux32, Linux64, and Win32: Build litecoind and litecoin-qt on Linux32, Linux64, and Win32:
./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian.yml ./bin/gbuild --commit litecoin=v${VERSION} ../litecoin/contrib/gitian-descriptors/gitian.yml
./bin/gsign --signer $SIGNER --release ${VERSION} --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian.yml ./bin/gsign --signer $SIGNER --release ${VERSION} --destination ../gitian.sigs/ ../litecoin/contrib/gitian-descriptors/gitian.yml
pushd build/out pushd build/out
zip -r bitcoin-${VERSION}-linux-gitian.zip * zip -r litecoin-${VERSION}-linux-gitian.zip *
mv bitcoin-${VERSION}-linux-gitian.zip ../../ mv litecoin-${VERSION}-linux-gitian.zip ../../
popd popd
./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-win32.yml ./bin/gbuild --commit litecoin=v${VERSION} ../litecoin/contrib/gitian-descriptors/gitian-win32.yml
./bin/gsign --signer $SIGNER --release ${VERSION}-win32 --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-win32.yml ./bin/gsign --signer $SIGNER --release ${VERSION}-win32 --destination ../gitian.sigs/ ../litecoin/contrib/gitian-descriptors/gitian-win32.yml
pushd build/out pushd build/out
zip -r bitcoin-${VERSION}-win32-gitian.zip * zip -r litecoin-${VERSION}-win32-gitian.zip *
mv bitcoin-${VERSION}-win32-gitian.zip ../../ mv litecoin-${VERSION}-win32-gitian.zip ../../
popd popd
Build output expected: Build output expected:
1. linux 32-bit and 64-bit binaries + source (bitcoin-${VERSION}-linux-gitian.zip) 1. linux 32-bit and 64-bit binaries + source (litecoin-${VERSION}-linux-gitian.zip)
2. windows 32-bit binary, installer + source (bitcoin-${VERSION}-win32-gitian.zip) 2. windows 32-bit binary, installer + source (litecoin-${VERSION}-win32-gitian.zip)
3. Gitian signatures (in gitian.sigs/${VERSION}[-win32]/(your gitian key)/ 3. Gitian signatures (in gitian.sigs/${VERSION}[-win32]/(your gitian key)/
repackage gitian builds for release as stand-alone zip/tar/installer exe repackage gitian builds for release as stand-alone zip/tar/installer exe
**Linux .tar.gz:** **Linux .tar.gz:**
unzip bitcoin-${VERSION}-linux-gitian.zip -d bitcoin-${VERSION}-linux unzip litecoin-${VERSION}-linux-gitian.zip -d litecoin-${VERSION}-linux
tar czvf bitcoin-${VERSION}-linux.tar.gz bitcoin-${VERSION}-linux tar czvf litecoin-${VERSION}-linux.tar.gz litecoin-${VERSION}-linux
rm -rf bitcoin-${VERSION}-linux rm -rf litecoin-${VERSION}-linux
**Windows .zip and setup.exe:** **Windows .zip and setup.exe:**
unzip bitcoin-${VERSION}-win32-gitian.zip -d bitcoin-${VERSION}-win32 unzip litecoin-${VERSION}-win32-gitian.zip -d litecoin-${VERSION}-win32
mv bitcoin-${VERSION}-win32/bitcoin-*-setup.exe . mv litecoin-${VERSION}-win32/litecoin-*-setup.exe .
zip -r bitcoin-${VERSION}-win32.zip bitcoin-${VERSION}-win32 zip -r litecoin-${VERSION}-win32.zip bitcoin-${VERSION}-win32
rm -rf bitcoin-${VERSION}-win32 rm -rf litecoin-${VERSION}-win32
**Perform Mac build:** **Perform Mac build:**
OSX binaries are created by Gavin Andresen on a 32-bit, OSX 10.6 machine. OSX binaries are created by Gavin Andresen on a 32-bit, OSX 10.6 machine.
qmake RELEASE=1 USE_UPNP=1 USE_QRCODE=1 bitcoin-qt.pro qmake RELEASE=1 USE_UPNP=1 USE_QRCODE=1 litecoin-qt.pro
make make
export QTDIR=/opt/local/share/qt4 # needed to find translations/qt_*.qm files export QTDIR=/opt/local/share/qt4 # needed to find translations/qt_*.qm files
T=$(contrib/qt_translations.py $QTDIR/translations src/qt/locale) T=$(contrib/qt_translations.py $QTDIR/translations src/qt/locale)
@ -110,14 +107,14 @@ repackage gitian builds for release as stand-alone zip/tar/installer exe
* create SHA256SUMS for builds, and PGP-sign it * create SHA256SUMS for builds, and PGP-sign it
* update bitcoin.org version * update litecoin.org version
make sure all OS download links go to the right versions make sure all OS download links go to the right versions
* update forum version * update forum version
* update wiki download links * update wiki download links
* update wiki changelog: [https://en.bitcoin.it/wiki/Changelog](https://en.bitcoin.it/wiki/Changelog) * update wiki changelog: [https://en.litecoin.it/wiki/Changelog](https://en.bitcoin.it/wiki/Changelog)
Commit your signature to gitian.sigs: Commit your signature to gitian.sigs:
@ -132,32 +129,32 @@ Commit your signature to gitian.sigs:
### After 3 or more people have gitian-built, repackage gitian-signed zips: ### After 3 or more people have gitian-built, repackage gitian-signed zips:
From a directory containing bitcoin source, gitian.sigs and gitian zips From a directory containing litecoin source, gitian.sigs and gitian zips
export VERSION=0.5.1 export VERSION=0.5.1
mkdir bitcoin-${VERSION}-linux-gitian mkdir litecoin-${VERSION}-linux-gitian
pushd bitcoin-${VERSION}-linux-gitian pushd litecoin-${VERSION}-linux-gitian
unzip ../bitcoin-${VERSION}-linux-gitian.zip unzip ../litecoin-${VERSION}-linux-gitian.zip
mkdir gitian mkdir gitian
cp ../bitcoin/contrib/gitian-downloader/*.pgp ./gitian/ cp ../litecoin/contrib/gitian-downloader/*.pgp ./gitian/
for signer in $(ls ../gitian.sigs/${VERSION}/); do for signer in $(ls ../gitian.sigs/${VERSION}/); do
cp ../gitian.sigs/${VERSION}/${signer}/bitcoin-build.assert ./gitian/${signer}-build.assert cp ../gitian.sigs/${VERSION}/${signer}/litecoin-build.assert ./gitian/${signer}-build.assert
cp ../gitian.sigs/${VERSION}/${signer}/bitcoin-build.assert.sig ./gitian/${signer}-build.assert.sig cp ../gitian.sigs/${VERSION}/${signer}/litecoin-build.assert.sig ./gitian/${signer}-build.assert.sig
done done
zip -r bitcoin-${VERSION}-linux-gitian.zip * zip -r litecoin-${VERSION}-linux-gitian.zip *
cp bitcoin-${VERSION}-linux-gitian.zip ../ cp litecoin-${VERSION}-linux-gitian.zip ../
popd popd
mkdir bitcoin-${VERSION}-win32-gitian mkdir litecoin-${VERSION}-win32-gitian
pushd bitcoin-${VERSION}-win32-gitian pushd litecoin-${VERSION}-win32-gitian
unzip ../bitcoin-${VERSION}-win32-gitian.zip unzip ../litecoin-${VERSION}-win32-gitian.zip
mkdir gitian mkdir gitian
cp ../bitcoin/contrib/gitian-downloader/*.pgp ./gitian/ cp ../litecoin/contrib/gitian-downloader/*.pgp ./gitian/
for signer in $(ls ../gitian.sigs/${VERSION}-win32/); do for signer in $(ls ../gitian.sigs/${VERSION}-win32/); do
cp ../gitian.sigs/${VERSION}-win32/${signer}/bitcoin-build.assert ./gitian/${signer}-build.assert cp ../gitian.sigs/${VERSION}-win32/${signer}/litecoin-build.assert ./gitian/${signer}-build.assert
cp ../gitian.sigs/${VERSION}-win32/${signer}/bitcoin-build.assert.sig ./gitian/${signer}-build.assert.sig cp ../gitian.sigs/${VERSION}-win32/${signer}/litecoin-build.assert.sig ./gitian/${signer}-build.assert.sig
done done
zip -r bitcoin-${VERSION}-win32-gitian.zip * zip -r litecoin-${VERSION}-win32-gitian.zip *
cp bitcoin-${VERSION}-win32-gitian.zip ../ cp litecoin-${VERSION}-win32-gitian.zip ../
popd popd
- Upload gitian zips to SourceForge - Upload gitian zips to SourceForge

14
doc/unit-tests.md

@ -1,14 +1,14 @@
Compiling/running bitcoind unit tests Compiling/running litecoind unit tests
------------------------------------ ------------------------------------
bitcoind unit tests are in the `src/test/` directory; they litecoind unit tests are in the `src/test/` directory; they
use the Boost::Test unit-testing framework. use the Boost::Test unit-testing framework.
To compile and run the tests: To compile and run the tests:
cd src cd src
make -f makefile.unix test_bitcoin # Replace makefile.unix if you're not on unix make -f makefile.unix test_litecoin # Replace makefile.unix if you're not on unix
./test_bitcoin # Runs the unit tests ./test_litecoin # Runs the unit tests
If all tests succeed the last line of output will be: If all tests succeed the last line of output will be:
`*** No errors detected` `*** No errors detected`
@ -16,10 +16,10 @@ If all tests succeed the last line of output will be:
To add more tests, add `BOOST_AUTO_TEST_CASE` functions to the existing To add more tests, add `BOOST_AUTO_TEST_CASE` functions to the existing
.cpp files in the test/ directory or add new .cpp files that .cpp files in the test/ directory or add new .cpp files that
implement new BOOST_AUTO_TEST_SUITE sections (the makefiles are implement new BOOST_AUTO_TEST_SUITE sections (the makefiles are
set up to add test/*.cpp to test_bitcoin automatically). set up to add test/*.cpp to test_litecoin automatically).
Compiling/running Bitcoin-Qt unit tests Compiling/running Litecoin-Qt unit tests
--------------------------------------- ---------------------------------------
Bitcoin-Qt unit tests are in the src/qt/test/ directory; they Bitcoin-Qt unit tests are in the src/qt/test/ directory; they
@ -29,7 +29,7 @@ To compile and run the tests:
qmake bitcoin-qt.pro BITCOIN_QT_TEST=1 qmake bitcoin-qt.pro BITCOIN_QT_TEST=1
make make
./bitcoin-qt_test ./litecoin-qt_test
To add more tests, add them to the `src/qt/test/` directory, To add more tests, add them to the `src/qt/test/` directory,
the `src/qt/test/test_main.cpp` file, and bitcoin-qt.pro. the `src/qt/test/test_main.cpp` file, and bitcoin-qt.pro.

Loading…
Cancel
Save