Archiving notice

This repository is no longer maintained. For details, please refer to the README on zkevm-circuits

---

[Deprecated] zkEVM (Community Edition) Documentation

This is the documentation of the design and specification of the zkEVM community edition.

This documentation is written in markdown and organized into an mdbook which can be viewed here.

Setup

First install mdbook and the enabled extensions:

cargo install mdbook
cargo install mdbook-mermaid
cargo install mdbook-toc

Now the mdbook can be built and served locally at localhost:3000:

mdbook serve