diff --git a/README.md b/README.md index 0c58e5a..b2da371 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # Verifiers for Hylé -This repository contains various programs to verify zero-knowledge proofs within the (Hylé blockchain)[http://github.com/hyle-org/hyle]. +This repository contains various programs to verify zero-knowledge proofs within the [Hylé blockchain](http://github.com/hyle-org/hyle). Structure: - `hyle-contract` works as a minimal SDK, specifying required outputs for verifying ZK proofs. -- `midenvm-verifier` implements (WIP) a verifier for MASM. See (their doc)[https://0xpolygonmiden.github.io/miden-vm/intro/main.html] +- `midenvm-verifier` implements (WIP) a verifier for MASM. See [their doc](https://0xpolygonmiden.github.io/miden-vm/intro/main.html) - `noir-verifier` is a verifier for Noir/Barretenberg proofs, most used within the Aztec blockchain. - `risc0-verifier` is used with RISC zero. - `sp1-verifier`is used with SP1. @@ -19,7 +19,7 @@ Simply run `cargo build --release` within the repository to compile everything ### Typescript -The noir verifier is a typescript project. We recommend using `bun` to run it. Installations instructions (here)[https://bun.sh] +The noir verifier is a typescript project. We recommend using `bun` to run it. Installations instructions [here](https://bun.sh) There's no need to actually build it, but hylé expects `bun` to be in the path. ## Using within Hylé