2022-01-27 15:18:48 -08:00
|
|
|
# halo2_gadgets [![Crates.io](https://img.shields.io/crates/v/halo2_gadgets.svg)](https://crates.io/crates/halo2_gadgets) #
|
2020-10-20 14:12:51 -07:00
|
|
|
|
2022-02-14 13:56:56 -08:00
|
|
|
**IMPORTANT**: This library is in beta, and should not be used in production software.
|
2020-10-20 14:12:51 -07:00
|
|
|
|
2021-03-25 12:13:25 -07:00
|
|
|
Requires Rust 1.51+.
|
|
|
|
|
2020-10-20 15:09:21 -07:00
|
|
|
## Documentation
|
|
|
|
|
2022-01-27 15:18:48 -08:00
|
|
|
- [The Halo 2 Book](https://zcash.github.io/halo2/)
|
|
|
|
- [Crate documentation](https://docs.rs/halo2_gadgets)
|
2020-10-20 14:12:51 -07:00
|
|
|
|
|
|
|
## License
|
|
|
|
|
2022-02-14 13:29:51 -08:00
|
|
|
Copyright 2020-2022 The Electric Coin Company.
|
2020-10-20 14:12:51 -07:00
|
|
|
|
2021-04-16 09:24:18 -07:00
|
|
|
You may use this package under the Bootstrap Open Source Licence, version 1.0,
|
2022-02-14 13:29:51 -08:00
|
|
|
or at your option, any later version. See the file [`COPYING`](../COPYING) for
|
|
|
|
more details, and [`LICENSE-BOSL`](../LICENSE-BOSL) for the terms of the Bootstrap
|
2021-09-22 13:43:08 -07:00
|
|
|
Open Source Licence, version 1.0.
|
2021-04-16 09:24:18 -07:00
|
|
|
|
|
|
|
The purpose of the BOSL is to allow commercial improvements to the package
|
|
|
|
while ensuring that all improvements are open source. See
|
|
|
|
[here](https://electriccoin.co/blog/introducing-tgppl-a-radically-new-type-of-open-source-license/)
|
|
|
|
for why the BOSL exists.
|