halo2/README.md

26 lines
966 B
Markdown
Raw Normal View History

2020-08-22 13:15:39 -07:00
# halo2 [![Crates.io](https://img.shields.io/crates/v/halo2.svg)](https://crates.io/crates/halo2) #
**IMPORTANT**: This library is being actively developed and should not be used in production software.
## [Documentation](https://docs.rs/halo2)
2021-06-01 16:01:04 -07:00
## 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.
2020-08-22 13:15:39 -07:00
## License
Copyright 2020 The Electric Coin Company.
2021-04-16 08:33:10 -07:00
You may use this package under the Bootstrap Open Source Licence, version 1.0,
or at your option, any later version. See the file
[`LICENSE-BOSL`](LICENSE-BOSL) for the terms of the Bootstrap Open Source
Licence, version 1.0.
2020-08-22 13:15:39 -07:00
2021-04-16 08:33:10 -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.