logos-storage/plonky2
1
0
Fork 0
mirror of https://github.com/logos-storage/plonky2.git synced 2026-01-03 06:13:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #960 from mir-protocol/readme-updates

Browse Source 
README updates: examples and external tutorial
This commit is contained in:
Nicholas Ward 2023-04-05 13:57:24 -07:00 committed by GitHub
commit c11f4f41c7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -7,6 +7,17 @@ This repository was originally for Plonky2, a SNARK implementation based on tech
For more details about the Plonky2 argument system, see this [writeup](plonky2/plonky2.pdf).
Polymer Labs has written up a helpful tutorial [here](https://polymerlabs.medium.com/a-tutorial-on-writing-zk-proofs-with-plonky2-part-i-be5812f6b798)!
## Examples
A good starting point for how to use plonky2 for simple applications is the included examples:
* [`factorial`](plonky2/examples/factorial.rs): Proving knowledge of 100!
* [`fibonacci`](plonky2/examples/fibonacci.rs): Proving knowledge of the hundredth Fibonacci number
* [`square_root`](plonky2/examples/square_root.rs): Proving knowledge of the square root of a given field element
## Building