2020-08-22 13:15:39 -07:00
|
|
|
# halo2 [](https://crates.io/crates/halo2) #
|
|
|
|
|
|
|
|
|
|
**IMPORTANT**: This library is being actively developed and should not be used in production software.
|
|
|
|
|
|
|
|
|
|
## [Documentation](https://docs.rs/halo2)
|
|
|
|
|
|
2021-06-01 16:01:04 -07:00
|
|
|
## Minimum Supported Rust Version
|
|
|
|
|
|
|
|
|
|
Requires Rust **1.51** or higher.
|
|
|
|
|
|
|
|
|
|
Minimum supported Rust version can be changed in the future, but it will be done with a
|
|
|
|
|
minor version bump.
|
2021-02-23 05:25:37 -08:00
|
|
|
|
2021-06-24 04:24:08 -07:00
|
|
|
## Controlling parallelism
|
|
|
|
|
|
|
|
|
|
`halo2` currently uses [rayon](https://github.com/rayon-rs/rayon) for parallel computation.
|
|
|
|
|
The `RAYON_NUM_THREADS` environment variable can be used to set the number of threads.
|
|
|
|
|
|
2020-08-22 13:15:39 -07:00
|
|
|
## License
|
|
|
|
|
|
2021-06-24 04:24:08 -07:00
|
|
|
Copyright 2020-2021 The Electric Coin Company.
|
2020-08-22 13:15:39 -07:00
|
|
|
|
2021-04-16 08:33:10 -07:00
|
|
|
You may use this package under the Bootstrap Open Source Licence, version 1.0,
|
2021-09-22 12:11:13 -07:00
|
|
|
or at your option, any later version. See the file [`COPYING`](COPYING) for
|
|
|
|
|
more details, and [`LICENSE-BOSL`](LICENSE-BOSL) for the terms of the Bootstrap
|
|
|
|
|
Open Source Licence, version 1.0.
|
2020-08-22 13:15:39 -07:00
|
|
|
|
2021-04-16 08:33:10 -07:00
|
|
|
The purpose of the BOSL is to allow commercial improvements to the package
|
|
|
|
|
while ensuring that all improvements are open source. See
|
|
|
|
|
[here](https://electriccoin.co/blog/introducing-tgppl-a-radically-new-type-of-open-source-license/)
|
2021-06-24 04:24:08 -07:00
|
|
|
for why the BOSL exists.
|
