Go to file
Daira-Emma Hopwood 81729eca91
Merge pull request #809 from daira/remove-empty-halo2-crate-from-readme
Remove references to the empty `halo2` crate from the README
2024-02-06 15:25:48 +00:00
.github Bump codecov/codecov-action from 3.1.1 to 3.1.4 2023-05-16 10:59:10 +00:00
book Revert "Add book/Makefile for local HTML generation." 2023-11-29 21:54:04 +00:00
halo2 Set `rust-version` to 1.60 in `{halo2,halo2_proofs,halo2_gadgets}/Cargo.toml`. 2023-11-23 14:17:31 +00:00
halo2_gadgets Change Daira Emma's name in `authors` fields. 2023-11-29 21:54:04 +00:00
halo2_proofs Change Daira Emma's name in `authors` fields. 2023-11-29 21:54:04 +00:00
.gitignore Add `/book/book` to `.gitignore`. 2023-11-29 21:54:04 +00:00
COPYING.md Relicense Halo 2 crates as MIT OR Apache 2.0 2022-04-07 14:22:49 +00:00
Cargo.lock The test-dev-graph features needs plotters/ttf to be able to draw text. 2023-11-23 14:17:31 +00:00
Cargo.toml Migrate to published `ff 0.13` 2022-12-06 04:55:21 +00:00
LICENSE-APACHE Relicense Halo 2 crates as MIT OR Apache 2.0 2022-04-07 14:22:49 +00:00
LICENSE-MIT Add an umbrella copyright line to cover future contributors 2022-04-07 14:51:05 +00:00
README.md Remove references to the empty `halo2` crate from the README, and link 2024-02-06 12:54:21 +00:00
rust-toolchain.toml Bump MSRV to 1.60 2023-02-10 18:09:11 +00:00

README.md

halo2

Usage

This repository contains the halo2_proofs and halo2_gadgets crates, which should be used directly.

Minimum Supported Rust Version

Requires Rust 1.60 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.

You can disable rayon by disabling the "multicore" feature. Warning! Halo2 will lose access to parallelism if you disable the "multicore" feature. This will significantly degrade performance.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.