From cb74c460fc8f4f64d8ad3f9ff84b528a8a9ed96d Mon Sep 17 00:00:00 2001 From: nzsquirrell Date: Sat, 7 Nov 2015 13:57:08 +1300 Subject: [PATCH] include some basic build instructions and requirements --- README.md | 41 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c27233fd..28be9a96 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ with no central authority: managing transactions and issuing money are carried out collectively by the network. Myriadcoin Core is the name of open source software which enables the use of this currency. -For more information, as well as an immediately useable, binary version of +For more information, as well as an immediately usable, binary version of the Myriadcoin Core software, see http://www.myriadcoin.org/ License @@ -26,6 +26,45 @@ License Myriadcoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for more information or see http://opensource.org/licenses/MIT. +Building +-------- + +See files in the [doc](doc) directory for generic build instructions for Windows, +OSX and Unix. Basic requirements: + +* GCC and binuntils +* Git +* Boost C++ libraries +* Berkeley DB - Should be version 4.8, newer versions are known to work but not guaranteed +* libssl (part of openssl) +* [miniupnpc](http://miniupnp.free.fr/) for optional UPNP support + +Requirements to build the GUI: + +* QT4 or QT5 development libraries +* protobuf development libraries +* libqrencode development libraries + +A common question is how to build from Ubuntu, instructions follow: + +1. sudo add-apt-repository ppa:bitcoin/bitcoin -y +2. sudo apt-get update +3. sudo apt-get install build-essential curl git libminiupnpc-dev libssl-dev m4 -y +4. sudo apt-get install libdb4.8-dev libdb4.8++-dev -y +5. sudo apt-get install libprotoc-dev libprotobuf-dev -y +6. sudo apt-get install libtool automake autoconf make pkg-config -y +7. sudo apt-get install libpng-dev -y +8. sudo apt-get install libqrencode-dev -y +9. sudo apt-get install libqt4-dev -y +10. sudo apt-get install libboost-all-dev -y +11. sudo apt-get install libcurl4-openssl-dev -y +12. git clone git://github.com/myriadteam/myriadcoin.git +13. cd myriadcoin +14. ./autogen.sh +15. ./configure +16. make + + Development process -------------------