Skip to content

Update Circom optimization flag documentation #32

Description

@johnson86tw

Issue Description

The documentation in docs/zk-email-verifier/usage-guide.md contains outdated information about Circom's default optimization flags.

Current Documentation (Line 68)

Additionally, we generally recommend using the --O0 flag for optimization during compilation for beginners. However, if you're more experienced with Circom, feel free to use the --O1 flag instead. It's important to avoid using the --O2 flag as that is the default setting and it may lead to the deletion of additional constraints.

Correct Information

  • --O1 is the current default (since circom 2.2.0)
  • Before version 2.2.0, --O2 was the default

Suggested Fix

The documentation should be updated to reflect that --O1 is now the default optimization level in Circom 2.2.0+, and adjust the recommendations accordingly.

Location

File: docs/zk-email-verifier/usage-guide.md
Lines: 68-69
Section: Step 3: Compile your circuit

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions