Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md to include ToC #3

Merged
merged 1 commit into from
Oct 2, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,27 @@
A succinct reference to correctly constraining circuits
</h1>

## Table of Contents
- [Overview](#overview)
- [Recommended Tools](#recommended-tools)
- [circom docs: --inspect option](#circom-docs---inspect-option)
- [circomspect static analyzer and linter for circom](#circomspect-static-analyzer-and-linter-for-circom)
- [circomkit circom testing suite](#circomkit-circom-testing-suite)
- [Not recommended](#not-recommended)
- [zksecurity circomscribe - demo playground, visualize constraints](#zksecurity-circomscribe---demo-playground-visualize-constraints-)
- [Picus QED uniqueness property underconstraint checker](#picus-qed-uniqueness-property-underconstraint-checker)
- [Backlog list of further tools to examine](#backlog-list-of-further-tools-to-examine)
- [Everything you should know about correctly assigning constraints](#everything-you-should-know-about-correctly-assigning-constraints)
- [The basics](#the-basics)
- [When may a developer choose to use `<--` assignment over `<==`?](#when-may-a-developer-choose-to-use----assignment-over-)
- [Common mistakes in underconstraining circuits](#common-mistakes-in-underconstraining-circuits)
- [Further Reading](#further-reading)
- [Recommended short reading](#recommended-short-reading)
- [Recommended longer reading](#recommended-longer-reading)
- [Also reviewed in preparation for this post](#also-reviewed-in-preparation-for-this-post)
- [License](#license)
- [Contributing](#contributing)

## Overview
This repo is a reference on correctly testing and constraining circom circuits, with example workflows and reference patterns.

Expand Down