Go to file

str4d d111807798 Merge pull request #465 from zcash/462-workspace Refactor into workspace with `halo2` and `halo2_proofs`		2022-01-20 20:26:38 +00:00
.github	fix(ci): wasm CI now uses the correct targets	2022-01-08 17:10:01 +02:00
book	Move `halo2` code into `halo2_proofs` crate	2022-01-20 18:50:43 +00:00
examples/sha256	Move `halo2` code into `halo2_proofs` crate	2022-01-20 18:50:43 +00:00
halo2	Recreate `halo2` as an empty library crate	2022-01-20 18:50:43 +00:00
halo2_proofs	Move `halo2` code into `halo2_proofs` crate	2022-01-20 18:50:43 +00:00
.gitignore	Add book/Makefile for local HTML generation.	2020-12-26 15:33:59 +00:00
COPYING	Update COPYING with latest license text	2021-09-22 20:06:50 +01:00
Cargo.toml	Recreate `halo2` as an empty library crate	2022-01-20 18:50:43 +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	halo2 0.1.0-beta.1	2021-09-24 17:00:13 +01:00
katex-header.html	Initial commit	2020-08-22 14:15:39 -06: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.