https://github.com/erhant/circom101
Circom circuits explained in depth.
https://github.com/erhant/circom101
blog circom circomkit mdbook tutorial
Last synced: 30 days ago
JSON representation
Circom circuits explained in depth.
- Host: GitHub
- URL: https://github.com/erhant/circom101
- Owner: erhant
- License: mit
- Created: 2023-07-08T11:27:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-28T21:52:54.000Z (10 months ago)
- Last Synced: 2025-01-13T06:43:22.603Z (9 months ago)
- Topics: blog, circom, circomkit, mdbook, tutorial
- Language: Circom
- Homepage: https://circom.erhant.me
- Size: 713 KB
- Stars: 24
- Watchers: 4
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Circom101
Circom circuit implementations with in-depth explanations.
## Setup
Install packages with:
```sh
bun install
```
## Book
We use `mdbook` to create the book, see the [book](./book/) folder. You can build the book with the following:
```sh
bun book # automatically serve the book
bun book:build # build without serving
```
The book is based on the [mdBook template](https://github.com/erhant/mdbook-template) and is published at .
## Tests
Run circuit tests with:
```sh
bun test
# with pattern matching
bun test pattern-name
# with explicit paths
bun test ./path/to/some.test.ts
```
The tests make use of [Circomkit](https://github.com/erhant/circomkit).
## Style
Check the formatting with the following command:
```sh
bun format
```
This command checks the test code with [Prettier](https://www.npmjs.com/package/prettier).