diff --git a/README.md b/README.md index 96354f0f6..8c7767051 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # Chia Proof of Space + ![Build](https://github.com/Chia-Network/chiapos/actions/workflows/build-test-cplusplus.yml/badge.svg) ![Wheels](https://github.com/Chia-Network/chiapos/actions/workflows/build-wheels.yml/badge.svg) ![PyPI](https://img.shields.io/pypi/v/chiapos?logo=pypi) @@ -24,7 +25,9 @@ cmake --build . -- -j 6 ``` ## Static Compilation With glibc + ### Statically compile ProofOfSpace + ```bash mkdir -p build && cd build cmake -DBUILD_PROOF_OF_SPACE_STATICALLY=ON ../ @@ -53,13 +56,11 @@ cmake --build . -- -j 6 time ./ProofOfSpace -k 25 create ``` - ### Hellman Attacks usage There is an experimental implementation which implements some of the Hellman Attacks that can provide significant space savings for the final file. - ```bash ./HellmanAttacks -k 18 -f "plot.dat" -m "0x1234" create ./HellmanAttacks -f "plot.dat" check @@ -90,6 +91,7 @@ py.test ./tests -s -v Finally, Rust bindings are provided, but only validation of proofs of space is supported, and it cannot be used to make plots or create proofs for plots. ## ci Building + The primary build process for this repository is to use GitHub Actions to build binary wheels for MacOS, Linux (x64 and aarch64), and Windows and publish them with a source wheel on PyPi. See `.github/workflows/build.yml`. CMake uses @@ -99,6 +101,7 @@ managed by [cibuildwheel](https://github.com/joerick/cibuildwheel). Further installation is then available via `pip install chiapos` e.g. ## Contributing and workflow + Contributions are welcome and more details are available in chia-blockchain's [CONTRIBUTING.md](https://github.com/Chia-Network/chia-blockchain/blob/main/CONTRIBUTING.md).