Go to file
Daira Hopwood f358f72899
Merge pull request #401 from zcash/book-plonkish-terms
book: Rename remaining UPA references to PLONKish
2021-11-15 15:09:26 -05:00
.github CI: Add Dependabot config to keep Actions up-to-date 2021-11-04 16:42:47 +00:00
benches Remove redundant Error suffix from Error cases 2021-11-10 16:19:36 +00:00
book book: Rename remaining UPA references to PLONKish 2021-11-15 15:53:38 +00:00
examples Remove redundant Error suffix from Error cases 2021-11-10 16:19:36 +00:00
proptest-regressions/plonk/circuit Refactor the selector optimization pass so it can be independently proptested. 2021-07-24 16:35:45 -06:00
src Fix broken doc link 2021-11-10 16:19:36 +00:00
tests Remove redundant Error suffix from Error cases 2021-11-10 16:19:36 +00:00
.gitignore Add book/Makefile for local HTML generation. 2020-12-26 15:33:59 +00:00
CHANGELOG.md `impl std::error::Error for Error` 2021-11-10 16:19:36 +00:00
COPYING Update COPYING with latest license text 2021-09-22 20:06:50 +01:00
Cargo.toml Add [BETA] to the crate description 2021-09-24 17:08:46 +01: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 Crates.io

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

Copyright 2020-2021 The Electric Coin Company.

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.