BTCPrivate
/
BTCP-Rebase
mirror of https://github.com/BTCPrivate/BTCP-Rebase.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #39 from ch4ot1c/docs/simple-instructions 

[docs] Added Ubuntu build instructions to README
This commit is contained in:
Jon Layton 2018-08-02 10:57:43 -05:00 committed by GitHub
parent dd739d6925 ad27f01122
commit 26450eb3e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -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
------
@ -13,9 +13,31 @@ 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 +51,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 +62,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
-------