Charon/blockchain
1
0
Fork 0
forked from lthn/blockchain
Code Pull requests Activity

readme: versions update, boost link fix, grammar corrections, GUI/server emphasized

Browse source
This commit is contained in:
sowle 2021-06-03 16:02:15 +03:00
parent 1a8c6b0dfa
commit 907d428689
No known key found for this signature in database
GPG key ID: C07A24B2D89D49FC
1 changed files with 42 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

70
README.md
View file

@ -1,61 +1,73 @@
[![Coverity Scan](https://scan.coverity.com/projects/18767/badge.svg)](https://scan.coverity.com/projects/zanoproject) [![Coverity Scan](https://scan.coverity.com/projects/18767/badge.svg)](https://scan.coverity.com/projects/zanoproject)
[![Discord](https://img.shields.io/discord/538361472691077130?label=discord&logo=discord)](https://discord.gg/wE3rmYY) [![Discord](https://img.shields.io/discord/538361472691077130?label=discord&logo=discord)](https://discord.gg/wE3rmYY)
Building ## Cloning
Be sure to clone the repository properly:\
`$ git clone --recursive https://github.com/hyle-team/zano.git`
# Building
-------- --------
### Cloning
Be sure to properly clone the repository:
`$ git clone --recursive https://github.com/hyle-team/zano.git`
### Dependencies ### Dependencies
| component / version | minimum <br>(not recommended but may work) | recommended | most recent of what we have ever tested | | component / version | minimum <br>(not recommended but may work) | recommended | most recent of what we have ever tested |
|--|--|--|--| |--|--|--|--|
| gcc (Linux) | 5.4.0 | 7.2.0 | 8.3.0 | | gcc (Linux) | 5.4.0 | 7.4.0 | 8.3.0 |
| llvm/clang (Linux) | UNKNOWN | 7.0.1 | 8.0.0 | | llvm/clang (Linux) | UNKNOWN | 7.0.1 | 8.0.0 |
| [MSVC](https://visualstudio.microsoft.com/downloads/) (Windows) | 2015 (14.0 update 1) | 2017 (15.5.7) | 2019 | | [MSVC](https://visualstudio.microsoft.com/downloads/) (Windows) | 2015 (14.0 update 1) | 2017 (15.9.0) | 2019 |
| [XCode](https://developer.apple.com/downloads/) (macOS) | 7.3.1 | 9.2 | 9.2 | | [XCode](https://developer.apple.com/downloads/) (macOS) | 9.2 | 12.3 | 12.3 |
| [CMake](https://cmake.org/download/) | 2.8.6 | 3.15.5 | 3.15.5 | | [CMake](https://cmake.org/download/) | 2.8.6 | 3.15.5 | 3.18.1 |
| [Boost](https://www.boost.org/users/download/) | 1.56 | 1.68 | 1.68 | | [Boost](https://www.boost.org/users/download/) | 1.56 | 1.68 | 1.69 |
| [Qt](https://download.qt.io/archive/qt/) (only for GUI) | 5.8.0 | 5.11.2 | 5.13.2 | | [Qt](https://download.qt.io/archive/qt/) (*only for GUI*) | 5.8.0 | 5.11.2 | 5.13.2 |
### Linux ### Linux
Recommended OS version: Ubuntu 18.04 LTS. Recommended OS version: Ubuntu 18.04 LTS.
1. Prerequisites 1. Prerequisites
1. Prerequisites for server version:
sudo apt-get install -y build-essential g++ python-dev autotools-dev libicu-dev libbz2-dev cmake git screen
1. Prerequisites for GUI version:
sudo apt-get install -y build-essential g++ python-dev autotools-dev libicu-dev libbz2-dev cmake git screen mesa-common-dev libglu1-mesa-dev` [*server version*]
sudo apt-get install -y build-essential g++ python-dev autotools-dev libicu-dev libbz2-dev cmake git screen
[*GUI version*]
sudo apt-get install -y build-essential g++ python-dev autotools-dev libicu-dev libbz2-dev cmake git screen mesa-common-dev libglu1-mesa-dev`
2. Download and build Boost 2. Download and build Boost
wget https://dl.bintray.com/boostorg/release/1.68.0/source/boost_1_68_0.tar.bz2 wget https://boostorg.jfrog.io/artifactory/main/release/1.68.0/source/boost_1_68_0.tar.bz2
tar -xjf boost_1_68_0.tar.bz2 tar -xjf boost_1_68_0.tar.bz2
cd boost_1_68_0 cd boost_1_68_0
./bootstrap.sh --with-libraries=system,filesystem,thread,date_time,chrono,regex,serialization,atomic,program_options,locale,timer ./bootstrap.sh --with-libraries=system,filesystem,thread,date_time,chrono,regex,serialization,atomic,program_options,locale,timer
./b2 ./b2
3. Install Qt 3. Install Qt\
(*GUI version only, skip this step if you're building server version*)
[*GUI version*]
wget https://download.qt.io/new_archive/qt/5.11/5.11.2/qt-opensource-linux-x64-5.11.2.run wget https://download.qt.io/new_archive/qt/5.11/5.11.2/qt-opensource-linux-x64-5.11.2.run
chmod +x qt-opensource-linux-x64-5.11.2.run chmod +x qt-opensource-linux-x64-5.11.2.run
./qt-opensource-linux-x64-5.11.2.run ./qt-opensource-linux-x64-5.11.2.run
Then follow the instructions in Wizard. Don't forget to tick WebEngine module! Then follow the instructions in Wizard. Don't forget to tick the WebEngine module checkbox!
4. Set environment variables properly\
For instance, by adding the following lines to `~/.bashrc`
[*server version*]
export BOOST_ROOT=/home/user/boost_1_68_0
[*GUI version*]
4. Set `BOOST_ROOT` and `QT_PREFIX_PATH` envinorment variables\
For instance, by adding these lines to `~/.bashrc`:
export BOOST_ROOT=/home/user/boost_1_68_0 export BOOST_ROOT=/home/user/boost_1_68_0
export QT_PREFIX_PATH=/home/user/Qt5.11.2/5.11.2/gcc_64 export QT_PREFIX_PATH=/home/user/Qt5.11.2/5.11.2/gcc_64
5. Building binaries 5. Building binaries
1. Building daemon and simplewallet: 1. Building daemon and simplewallet:
@ -66,7 +78,7 @@ Recommended OS version: Ubuntu 18.04 LTS.
cmake .. cmake ..
make -j1 daemon simplewallet make -j1 daemon simplewallet
**NOTICE**: If you are building on machine with relatively high anount of RAM or with proper setting of virtual memory, then you can use `-j2` or `-j` option to speed up the building process. Use with caution. **NOTICE**: If you are building on a machine with a relatively high amount of RAM or with the proper setting of virtual memory, then you can use `-j2` or `-j` option to speed up the building process. Use with caution.
1. Building GUI: 1. Building GUI:
@ -75,6 +87,7 @@ Recommended OS version: Ubuntu 18.04 LTS.
7. Look for the binaries in `build` folder 7. Look for the binaries in `build` folder
<br>
### Windows ### Windows
Recommended OS version: Windows 7 x64. Recommended OS version: Windows 7 x64.
1. Install required prerequisites (Boost, Qt, CMake). 1. Install required prerequisites (Boost, Qt, CMake).
@ -83,13 +96,14 @@ Recommended OS version: Windows 7 x64.
4. Go to the build folder and open generated Zano.sln in MSVC. 4. Go to the build folder and open generated Zano.sln in MSVC.
5. Build. 5. Build.
In order to correctly deploy Qt GUI application you also need to do the following: In order to correctly deploy Qt GUI application, you also need to do the following:
6. Copy Zano.exe to a folder (e.g. `depoy`). 6. Copy Zano.exe to a folder (e.g. `depoy`).
7. Run `PATH_TO_QT\bin\windeployqt.exe deploy/Zano.exe`. 7. Run `PATH_TO_QT\bin\windeployqt.exe deploy/Zano.exe`.
8. Copy folder `\src\gui\qt-daemon\html` to `deploy\html`. 8. Copy folder `\src\gui\qt-daemon\html` to `deploy\html`.
<br>
### macOS ### macOS
Recommended OS version: macOS Sierra 10.12.6 x64. Recommended OS version: macOS Sierra 10.15.4 x64.
1. Install required prerequisites. 1. Install required prerequisites.
2. Set environment variables as stated in `utils/macosx_build_config.command`. 2. Set environment variables as stated in `utils/macosx_build_config.command`.
3. `mkdir build` <br> `cd build` <br> `cmake ..` <br> `make` 3. `mkdir build` <br> `cd build` <br> `cmake ..` <br> `make`
@ -104,7 +118,7 @@ To build GUI application:
e. Press “Create”, then “Done”.\ e. Press “Create”, then “Done”.\
f. Make sure the certificate was added to keychain "System". If not—move it to "System".\ f. Make sure the certificate was added to keychain "System". If not—move it to "System".\
g. Double click the certificate you've just added, enter the trust section and under "When using this certificate" select "Always trust".\ g. Double click the certificate you've just added, enter the trust section and under "When using this certificate" select "Always trust".\
h. Unfold the certificate in Keychain Access window and double click underlying private key "Zano". Select "Access Control" tab, then select "Allow all applications to access this item". Click "Save Changes". h. Unfold the certificate in Keychain Access window and double click the underlying private key "Zano". Select "Access Control" tab, then select "Allow all applications to access this item". Click "Save Changes".
2. Revise building script, comment out unwanted steps and run it: `utils/build_script_mac_osx.sh` 2. Revise building script, comment out unwanted steps and run it: `utils/build_script_mac_osx.sh`
3. The application should be here: `/buid_mac_osx_64/release/src` 3. The application should be here: `/buid_mac_osx_64/release/src`