From 2b01101d1ef262d1f521e2b067947988df0dd619 Mon Sep 17 00:00:00 2001 From: Jon Layton Date: Tue, 17 Jul 2018 13:50:47 -0500 Subject: [PATCH 1/2] [docs] Added Ubuntu build instructions --- README.md | 32 ++++++++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bd2132b7d..d2fa412ad 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,32 @@ This should build on linux and sync the full BTCP mainnet chain. Wallet code and Build Instructions ------- -Only linux builds have been reasonably tested. `scripts/build/sh` should build all the dependencies and bootstrap a linux build. -For macOS High Sierra users, compilation can be achieved by first installing libomp (necessary as Apple's version of Clang does not have support for OpenMP included); you can do that via the following Terminal commands: +#### Linux (>= Ubuntu 16.04): + +``` +cd scripts +./build.sh +``` + +Or alternatively: +``` +./autogen.sh +cd depends +make HOST=x86_64-unknown-linux-gnu +cd .. +./configure --prefix=$PWD/depends/x86_64-unknown-linux-gnu +make +``` + +This will build all the dependencies and bootstrap a linux build. There are several options you can use: +- `--disable-wallet` +- `--without-gui` +- `--help` + + +#### MacOS (High Sierra): +You must first install libomp (Apple's version of Clang does not have support for OpenMP included); you can do that via the following Terminal commands: Install XCode: ``` @@ -29,10 +52,9 @@ Install libomp: ``` brew install libomp ``` -Then run the `scripts/build-mac.sh` to compile. +Then, run `scripts/build-mac.sh` to compile. -https://btcprivate.org What is the Bitcoin Private Rebase? ---------------- @@ -41,6 +63,8 @@ Bitcoin Private is currently based primarily on the Zcash codebase, which itself We endeavor a complete refactoring of Bitcoin Private to allow for more facile incorporation of Bitcoin upstream changes. This release will coincide with activation of full SegWit support, giving the BTCP more scale both on chain as well as enabling off-chain protocols such as the lightning network and cross-chain swaps. Additionally, it will bring another 3 years of upgrades to the core node including stability and speed improvements as well as a number of usability enhancements to the reference wallet including support for hierarchical deterministic wallets (for shielded and transparent addresses) and wallet encryption. +Learn more about the rebase at https://btcprivate.org/roadmap. + License ------- From ad27f0112228e407d631f73dbfdcad623639c514 Mon Sep 17 00:00:00 2001 From: Jon Layton Date: Sat, 21 Jul 2018 18:55:30 -0500 Subject: [PATCH 2/2] [docs] README emphasis --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index d2fa412ad..4fe6d1efd 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Bitcoin Private Rebase IN DEVELOPMENT - FOR TESTING ONLY - DO NOT USE IN PRODUCTION =========== -This is currently in development software, not all consensus rules have been implemented. You should NOT rely on this in production yet, for production use cases please use https://github.com/BTCPrivate/BitcoinPrivate/ +This is currently in development software, not all consensus rules have been implemented. **You should NOT rely on this in production yet**, for production use cases please use https://github.com/BTCPrivate/BitcoinPrivate/ Development Status ------ @@ -15,7 +15,6 @@ Build Instructions ------- #### Linux (>= Ubuntu 16.04): - ``` cd scripts ./build.sh