Minor edits/revisons/formatting.

This commit is contained in:
JScottBranson
2025-11-07 16:59:22 -05:00
parent 01a04ba57c
commit 795a32cd66

View File

@@ -144,26 +144,28 @@ tools.build:cxxflags=['-Wno-restrict']
```
## Build xahaud
Inside the `.build` directory, with the Python3 virtual environment active, adjust "build_type" and then run the following:
1. Inside the `.build` directory, with the Python3 virtual environment active, adjust "build_type" to either "Release" or "Debug" and run the below command. It is possible to run the command twice to generate files for each "build_type".
```
conan install .. --output-folder . --build missing --settings build_type=["Release" or "Debug"] -c tools.build:verbosity=verbose -c tools.compilation:verbosity=verbose
```
`conan install .. --output-folder . --build missing --settings build_type=["Release" or "Debug"] -c tools.build:verbosity=verbose -c tools.compilation:verbosity=verbose`
2. If needed, additional options can be passed to Conan2:
```
conan install .. --output-folder . --build missing --settings build_type=["Release" or "Debug"] -s compiler=gcc -s compiler.version=12 -s compiler.libcxx=libstdc++11 -s compiler.cppstd=20 -c tools.build:verbosity=verbose -c tools.compilation:verbosity=verbose se -g VirtualBuildEnv -g VirtualRunEnv
```
If needed, additional options can be passed to Conan2:
`conan install .. --output-folder . --build missing --settings build_type=["Release" or "Debug"] -s compiler=gcc -s compiler.version=12 -s compiler.libcxx=libstdc++11 -s compiler.cppstd=20 -c tools.build:verbosity=verbose -c tools.compilation:verbosity=verbose se -g VirtualBuildEnv -g VirtualRunEnv`
After Conan2 is complete, run cmake:
3. After Conan2 is complete, run cmake. Do not specify "DCMAKE_BUILD_TYPE" if building from multiple configurations (both "Release" and "Debug").
```
cmake -DCMAKE_POLICY_DEFAULT_CMP0091=NEW \
-DCMAKE_BUILD_TYPE=$RELEASE_TYPE \
-DCMAKE_BUILD_TYPE=["Release" or "Debug"] \
-DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake \
..
```
Finally, use cmake to complete the build process: `cmake --build .`
4. Finally, use cmake to complete the build process: `cmake --build . ['--config Release' or '--config Debug' if multiple types were generated]`.
The output file will be named `rippled` and located in the `.build` directory. Rename the file to 'xahaud', and move it to it's final location (being careful not to overwrite the 'xahaud' GitHub repository).
The output file is named `rippled` and is located in the `.build` directory. If multiple build types (both "Release" and "Debug") were specified, the final product will be located at: `.build/["Release" or "Debug"]/rippled` Rename the file to 'xahaud', and move it to it's final location (being careful not to overwrite the 'xahaud' GitHub repository). Mark the final file as executable, and download a configuration file and validators file as needed.
## Test the Build
Will go here...
`./xahaud --unittest`