b9a057d791
* ci: update toolchain for docs/ghpages ci * refactor: move the "katex-header.html" file for docs/ghpages ci * chore: add the html copy/delete process in ci |
||
|---|---|---|
| .github | ||
| book | ||
| halo2 | ||
| halo2_backend | ||
| halo2_frontend | ||
| halo2_middleware | ||
| halo2_proofs | ||
| .gitignore | ||
| COPYING.md | ||
| Cargo.toml | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| README.md | ||
| rust-toolchain | ||
README.md
halo2 
Documentation
This repository contains the halo2 fork from PSE and includes contributions from the community.
We use the main branch for development, which means it may contain
unstable/unfinished features. For end-users we recomend using the tag releases
which can be seen as curated checkpoints with some level of guarantee of
stability.
For experimental features privacy-scaling-explorations/halo2 fork adds, please refer to experimental-features.md.
Minimum Supported Rust Version
Requires Rust 1.65.0 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.
When compiling to WASM-targets, notice that since version 1.7, rayon will fallback automatically (with no need to handle features) to require getrandom in order to be able to work. For more info related to WASM-compilation.
See: Rayon: Usage with WebAssembly for more
License
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
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.