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

Update README with build and packaging details

Browse source 
Expanded build instructions to clarify required tools and dependency handling. Added context about historical distribution methods and CPack usage for packaging. Provided guidance on skipping the packing step and removed redundant custom build section.
This commit is contained in:
Snider 2025-10-10 12:31:14 +01:00
parent 671a8528cc
commit 066e4570f2
1 changed files with 11 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -11,12 +11,21 @@
## Cloning
Be sure to clone the repository properly, with `--recursive` flag, or you'll get angry:
Be sure to clone the repository properly, with `--recursive` flag, or you'll get angry:<br/>
`git clone --recursive https://github.com/letheanVPN/blockchain.git`
# Building
The project uses a `Makefile` that provides a simple and powerful interface for building. It automatically handles dependency installation with Conan and compilation with CMake.
The project uses a `Makefile` that provides a simple and powerful interface for building.
It automatically handles dependency installation with Conan and compilation with CMake.
You need CMake and Make installed on your system, other than that you don't need to worry about Python, Conan, Boost, OpenSSL, or any other dependencies.
The final packages are created as they are due to a historical distribution method used in china: USB Stick, CD, DVD, etc.
We use CPack, so our pakages are self-contained, have searchable HTML documentation, and are ready to be installed on any system.
To skip the packing step, use `make build` as defined in the section below for Advanced Build Customization
## Simple Workflow Builds (Recommended)
@ -32,10 +41,6 @@ For most use cases, these two commands are all you need. They handle the entire
make testnet
```
## Custom Builds
You can use the `make build` target with variables for more control over the final binaries.
## Creating Release Packages
To create distributable packages (e.g., `.zip`, `.msi`, `.pkg`, `.deb`), run the `release` target. This will build the project, build the documentation, and then package everything.