diff --git a/mock/README.md b/mock/README.md new file mode 100644 index 000000000..8cd4a76c2 --- /dev/null +++ b/mock/README.md @@ -0,0 +1,19 @@ +# Miden mock + +Utilities to help test Miden programs. + +This crate contains builder and mock functions to create objects for testing. A +mock chain which allows the simulation of a rollup in-memory. And some precompute +values to speed up testing. + +## Features + +| name | description | +| ------------ | ----------------------------------------------------------------------------------------------------------------- | +| `std` | Allows usage of Rust's `std`, for `no-std` compile with `--no-default-features`. | +| `serde` | Enable `serde` based seralization of most objects. This feature allows saving the mock chains state to a file. | +| `executable` | Enables the creation of `mock` executable, used to save mock data to a file, which can later on be used by tests. | + +## License + +This project is [MIT licensed](../LICENSE).