Go to file

str4d 1e6bb51790 Merge pull request #540 from zcash/release-0.1.0-beta.4 Release halo2_proofs 0.1.0-beta.4		2022-04-06 12:23:23 +01:00
.github	CI: Test against Windows and macOS in addition to Ubuntu	2022-02-15 23:35:11 +00:00
book	[book] Correct typo in protocol description.	2022-03-17 21:35:06 +08:00
halo2	Fix docs.rs build	2022-03-17 19:14:11 +00:00
halo2_gadgets	halo2_gadgets 0.1.0-beta.3	2022-04-06 12:28:36 +08:00
halo2_proofs	halo2_proofs 0.1.0-beta.4	2022-04-06 12:24:28 +08:00
.gitignore	Add book/Makefile for local HTML generation.	2020-12-26 15:33:59 +00:00
COPYING	Update license dates and links	2022-02-14 21:58:20 +00:00
Cargo.toml	Integrate `halo2_gadgets` into the workspace	2022-01-27 23:32:04 +00:00
Contributor_Agreement	Correct numbering and add missing sections	2020-10-25 09:42:25 -07:00
LICENSE-BOSL	Changing TGPPL references to BOSL	2021-04-16 08:33:10 -07:00
README.md	Update license dates and links	2022-02-14 21:58:20 +00:00
rust-toolchain	Bump MSRV to 1.51.0	2021-06-02 00:03:06 +01:00

README.md

halo2

IMPORTANT: This library is in beta, and should not be used in production software.

Documentation

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.

Controlling parallelism

halo2 currently uses rayon for parallel computation. The RAYON_NUM_THREADS environment variable can be used to set the number of threads.

License

You may use this package under the Bootstrap Open Source Licence, version 1.0, or at your option, any later version. See the file COPYING for more details, and LICENSE-BOSL for the terms of the Bootstrap Open Source Licence, version 1.0.

The purpose of the BOSL is to allow commercial improvements to the package while ensuring that all improvements are open source. See here for why the BOSL exists.