Skip to content

Commit

Permalink
mock: add short readme (#502)
Browse files Browse the repository at this point in the history
  • Loading branch information
hackaugusto authored Mar 5, 2024
1 parent aa9e59c commit 6e315e5
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions mock/README.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit 6e315e5

Please sign in to comment.