ARCHIVE/xahaud
3
0
Fork 0
mirror of https://github.com/Xahau/xahaud.git synced 2025-12-06 17:27:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify Linux build instructions for configuring

Browse Source 
* Explain that Arch/Manjaro/etc. need `-Dstatic=OFF` during the configure step
* move configuration options closer to that step
* separate sub-headers for configuration and build
This commit is contained in:
Rome Reginelli
2019-08-01 18:46:57 -07:00
committed by Manoj doshi
parent 38f82115f7
commit 826cbbc3bf
1 changed files with 22 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
Builds/linux/README.md
View File

@@ -91,7 +91,7 @@ export BOOST_ROOT=~/boost_1_70_0
Alternatively, you can add `DBOOST_ROOT=~/boost_1_70_0` to the command line when Alternatively, you can add `DBOOST_ROOT=~/boost_1_70_0` to the command line when
invoking `cmake`. invoking `cmake`.
### Generate and Build ### Generate Configuration
All builds should be done in a separate directory from the source tree root All builds should be done in a separate directory from the source tree root
(a subdirectory is fine). For example, from the root of the ripple source tree: (a subdirectory is fine). For example, from the root of the ripple source tree:
@@ -107,6 +107,10 @@ followed by:
cmake -DCMAKE_BUILD_TYPE=Debug .. cmake -DCMAKE_BUILD_TYPE=Debug ..
``` ```
If your operating system does not provide static libraries (Arch Linux, and
Manjaro Linux, for example), you must configure a non-static build by adding
`-Dstatic=OFF` to the above cmake line.
`CMAKE_BUILD_TYPE` can be changed as desired for `Debug` vs. `CMAKE_BUILD_TYPE` can be changed as desired for `Debug` vs.
`Release` builds (all four standard cmake build types are supported). `Release` builds (all four standard cmake build types are supported).
@@ -115,20 +119,6 @@ To select a different compiler (most likely gcc will be found by default), pass
`-DCMAKE_CXX_COMPILER=</path/to/cxx-compiler>` when configuring. If you prefer, `-DCMAKE_CXX_COMPILER=</path/to/cxx-compiler>` when configuring. If you prefer,
you can instead set `CC` and `CXX` environment variables which cmake will honor. you can instead set `CC` and `CXX` environment variables which cmake will honor.
Once you have generated the build system, you can run the build via cmake:
```
cmake --build . -- -j <parallel jobs>
```
the `-j` parameter in this example tells the build tool to compile several
files in parallel. This value should be chosen roughly based on the number of
cores you have available and/or want to use for building.
When the build completes succesfully, you will have a `rippled` executable in
the current directory, which can be used to connect to the network (when
properly configured) or to run unit tests.
#### Options During Configuration: #### Options During Configuration:
The CMake file defines a number of configure-time options which can be The CMake file defines a number of configure-time options which can be
@@ -150,6 +140,23 @@ testing and running.
Several other infrequently used options are available - run `ccmake` or Several other infrequently used options are available - run `ccmake` or
`cmake-gui` for a list of all options. `cmake-gui` for a list of all options.
### Build
Once you have generated the build system, you can run the build via cmake:
```
cmake --build . -- -j <parallel jobs>
```
the `-j` parameter in this example tells the build tool to compile several
files in parallel. This value should be chosen roughly based on the number of
cores you have available and/or want to use for building.
When the build completes succesfully, you will have a `rippled` executable in
the current directory, which can be used to connect to the network (when
properly configured) or to run unit tests.
#### Optional Installation #### Optional Installation
The rippled cmake build supports an installation target that will install The rippled cmake build supports an installation target that will install