updated readme
Paul-Henry Kajfasz kajfaszph@gmail.com
Wed, 21 Aug 2024 14:18:41 +0100
1 files changed,
9 insertions(+),
1 deletions(-)
jump to
M
README.md
→
README.md
@@ -4,7 +4,7 @@ [](https://github.com/0xPolygonMiden/crypto/blob/main/LICENSE)
[](https://github.com/0xPolygonMiden/crypto/actions/workflows/test.yml) [](https://github.com/0xPolygonMiden/crypto/actions/workflows/build.yml) [](https://www.rust-lang.org/tools/install) -[](https://github.com/0xPolygonMiden/crypto/releases/) +[](https://crates.io/crates/miden-crypto) This crate contains cryptographic primitives used in Polygon Miden.@@ -47,6 +47,14 @@
- `FeltRng`: a trait for generating random field elements and random 4 field elements. - `RpoRandomCoin`: a struct implementing `FeltRng` as well as the [`RandomCoin`](https://github.com/facebook/winterfell/blob/main/crypto/src/random/mod.rs) trait using RPO hash function. - `RpxRandomCoin`: a struct implementing `FeltRng` as well as the [`RandomCoin`](https://github.com/facebook/winterfell/blob/main/crypto/src/random/mod.rs) trait using RPX hash function. + +## Make commands + +We use `make` to automate building, testing, and other processes. In most cases, `make` commands are wrappers around `cargo` commands with specific arguments. You can view the list of available commands in the [Makefile](Makefile), or run the following command: + +```shell +make +``` ## Crate features