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
regularly to indicate new official, stable release versions of Bitcoin.
regularly to indicate new official, stable release versions of Litecoin.
Testing
-------
@ -66,17 +70,5 @@ Unit tests for the GUI code are in `src/qt/test/`. To compile and run them:
@@ -66,17 +70,5 @@ Unit tests for the GUI code are in `src/qt/test/`. To compile and run them:
Distributed under the MIT/X11 software license, see the accompanying
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
@@ -11,7 +12,7 @@ cryptographic software written by Eric Young ([eay@cryptsoft.com](mailto:eay@cry
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
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.
@ -19,17 +20,17 @@ 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
---------------------
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`
Unpack the files into a directory and run:
- bin/32/bitcoin-qt (GUI, 32-bit)
- bin/32/bitcoind (headless, 32-bit)
- bin/64/bitcoin-qt (GUI, 64-bit)
- bin/64/bitcoind (headless, 64-bit)
- bin/32/litecoin-qt (GUI, 32-bit)
- bin/32/litecoind (headless, 32-bit)
- bin/64/litecoin-qt (GUI, 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)
Distributed under the MIT/X11 software license, see the accompanying
file COPYING or http://www.opensource.org/licenses/mit-license.php.
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).
@@ -10,7 +11,7 @@ cryptographic software written by Eric Young (eay@cryptsoft.com).
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
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.
@ -18,13 +19,10 @@ 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
-----
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.
However, it downloads and stores the entire history of Bitcoin transactions;
Litecoin-Qt is the original Litecoin client and it builds the backbone of the network.
However, it downloads and stores the entire history of Litecoin transactions;
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.
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
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
@@ -10,10 +10,10 @@ https://www.torproject.org/docs/faq.html.en#TBBSocksPort for how to properly
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.
-socks=5 SOCKS5 supports connecting-to-hostname, which can be used instead
@ -39,26 +39,26 @@ outgoing connections be anonimized, but more is possible.
@@ -39,26 +39,26 @@ outgoing connections be anonimized, but more is possible.
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
reachable from the Tor network. Add these lines to your /etc/tor/torrc (or equivalent
config file):
HiddenServiceDir /var/lib/tor/bitcoin-service/
HiddenServiceDir /var/lib/tor/litecoin-service/
HiddenServicePort 9333 127.0.0.1:9333
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
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
coming from unroutable addresses (such as 127.0.0.1, where the
Tor proxy typically runs).
@ -75,18 +75,18 @@ your bitcoind's P2P listen port (9333 by default).
@@ -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:
@ -26,7 +26,7 @@ Eric Young (eay@cryptsoft.com) and UPnP software written by Thomas Bernard.
@@ -26,7 +26,7 @@ Eric Young (eay@cryptsoft.com) and UPnP software written by Thomas Bernard.
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.
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.
@@ -72,14 +72,14 @@ Installing the dependencies using MacPorts is very straightforward.
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.
@ -107,12 +107,12 @@ If not, you can ensure that the Brew OpenSSL is correctly linked by running
@@ -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.
### Building `bitcoind`
### Building `litecoind`
1. Clone the github tree to get the source code and go into the directory.
2. Modify source in order to pick up the `openssl` library.
@ -122,7 +122,7 @@ Rerunning "openssl version" should now return the correct version.
@@ -122,7 +122,7 @@ Rerunning "openssl version" should now return the correct version.
patch -p1 <contrib/homebrew/makefile.osx.patch
3. Build bitcoind:
3. Build litecoind:
cd src
make -f makefile.osx
@ -134,10 +134,10 @@ Rerunning "openssl version" should now return the correct version.
@@ -134,10 +134,10 @@ Rerunning "openssl version" should now return the correct version.
Creating a release build
------------------------
A bitcoind binary is not included in the Bitcoin-Qt.app bundle. You can ignore
this section if you are building `bitcoind` for your own use.
A litecoind binary is not included in the Litecoin-Qt.app bundle. You can ignore
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:
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`.
@@ -156,30 +156,30 @@ As of December 2012, the `boost` port does not obey `macosx_deployment_target`.
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
-----
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:
@@ -128,7 +113,7 @@ If you need to build Boost yourself:
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:
* Position Independent Executable
@ -142,12 +127,11 @@ exploit even if a vulnerability is found, you can take the following measures:
@@ -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;"
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:
scanelf -e ./bitcoin
scanelf -e ./litecoin
The output should contain:
TYPE
@ -161,7 +145,7 @@ exploit even if a vulnerability is found, you can take the following measures:
@@ -161,7 +145,7 @@ exploit even if a vulnerability is found, you can take the following measures:
executable without the non-executable stack protection.
To verify that the stack is non-executable after compiling use:
@ -28,6 +28,12 @@ for Ubuntu >= 12.04 (please read the 'Berkely DB version warning' below):
@@ -28,6 +28,12 @@ for Ubuntu >= 12.04 (please read the 'Berkely DB version warning' below):
@ -35,9 +41,9 @@ then execute the following:
@@ -35,9 +41,9 @@ then execute the following:
qmake
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/
@ -62,11 +68,11 @@ Mac OS X
@@ -62,11 +68,11 @@ Mac OS X
brew update
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
- 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/
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:
@@ -127,9 +133,9 @@ flag to qmake to control this:
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.
Warren Togami
11 years ago