add documentation and clean up

This commit is contained in:
M Alghazwi 2025-01-09 10:37:06 +01:00
parent 563ba77a8c
commit 760dca9a08
No known key found for this signature in database
GPG Key ID: 646E567CAD7DB607
2 changed files with 3 additions and 3 deletions

View File

@ -16,6 +16,6 @@ Repository organization
Documentation
-----------------
To be added soon.
See the write-ups on [plonky2 storage proofs](https://hackmd.io/@NQdG6IOmQE6astjwhJ6ACw/rJSsScfAR) and [proof recursion](https://hackmd.io/@NQdG6IOmQE6astjwhJ6ACw/rk85D2HX1e)
**WARNING**: This repository contains work-in-progress prototypes, and has not received careful code review. It is NOT ready for production use.

View File

@ -19,8 +19,8 @@ This crate is an implementation of the [codex storage proofs circuits](https://g
- [`utils`](./src/circuits/utils.rs) contains helper functions.
## Documentation
writeup coming soon...
- [`recursion`](./src/recursion) contains various approaches of implementing recursion circuits for aggregating proofs.
## Usage
see [`workflow`](../workflow) for how to use the circuits and run them.