📝 Add Usage Example to README

[FeldmeierMichael]

Added function usage to readme

Summary by CodeRabbit

• Documentation
  • Updated README with help command documentation for the pexact command, including command synopsis, multi-input exact synthesis description, and available options for input variables and search space exploration modes.

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation update to the README showing the help invocation (pexact -h) for the pexact ABC command, including command synopsis, description, and available options for input variables and search space exploration.

Changes

Cohort / File(s)	Summary
Documentation README.md	Updated user usage instructions to document the -h help invocation for the pexact ABC command, replacing bare command example with full help output including synopsis and option descriptions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit hops through README lines, ✨
With -h flags that brightly shine,
Help commands now so crystal clear,
Pexact's secrets all appear! 🐰

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check	✅ Passed	The title 'Add Usage Example to README' accurately describes the main change: documentation updates to the README with usage information for the pexact command.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch Pexact-readme-usage-update

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

Updates the user-facing documentation to show pexact help/usage output when running the command in ABC.

Changes:

• Expand the README “Run ABC” section to include pexact -h invocation and printed usage/options.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 40: Update the README entry for the -I flag because it currently claims
"[default = 0]" which conflicts with the enforced nVars range; change the
documented valid range and default to match the code where nVars is constrained
to 2..4 (see PowerExactSynthesisBase and PexaManExactPowerSynthesisBasePower and
CONST_FOUR), e.g. document "-I <num> : the number of input variables [default =
2, valid range = 2..4]" (or whatever default the code sets) so the README and
the nVars constraint are consistent.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1771e556-e95b-42a7-bf26-4812006d247d

📥 Commits

Reviewing files that changed from the base of the PR and between 6732ce4 and b59513a.

📒 Files selected for processing (1)

• README.md

[marcelwa]

Cool!