Skip to content

Commit

Permalink
add a better README
Browse files Browse the repository at this point in the history
  • Loading branch information
rot256 committed Nov 9, 2024
1 parent e552d17 commit 6f49c7a
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
# Setup
# Halo Hero

This book is a course on [Halo2](https://github.com/zcash/halo2) development and PlonKish arithmetization in general.
The intended audience is Rust developers who have a vague understanding of succinct proofs in general,
but no specific knowledge of Halo2, PlonK or developing circuits for zkSNARKs.

The book was created as a collaboration between [ZKSecurity](https://zksecurity.xyz) and
the [Zircuit](https://www.zircuit.com/) development team.
All material, full code examples and the book's source, are available on [GitHub](https://github.com/zksecurity/halo2-course).

![zks](src/intro/zks-scale.png)

![zircuit](src/intro/zircuit.png)

## Running The Book

The book is build using `mdbook` and `mdbook-admonish`:

```
cargo install mdbook
cargo install mdbook-admonish
mdbook serve
```

0 comments on commit 6f49c7a

Please sign in to comment.