Skip to content

Improve project documentation#3

Merged
rainoftime merged 1 commit into
mainfrom
codex/improve-documentation-for-repository
May 8, 2026
Merged

Improve project documentation#3
rainoftime merged 1 commit into
mainfrom
codex/improve-documentation-for-repository

Conversation

@rainoftime
Copy link
Copy Markdown
Owner

Motivation

  • Make the project easier to use and understand by expanding and clarifying the top-level README.
  • Document the new/actual CLI entry points and runner modes so users can run and extend fuzzing campaigns without reading source.
  • Provide focused guidance for the inter-theory mutation component to help maintainers add bridges and reproduce issues.

Description

  • Expand the root README.md with installation instructions (PyPI and source), quick-start examples, command-line summaries, repository layout, development guidance, and bug-reporting instructions.
  • Refresh smtfuzz/runner/README.md to document the smtfuzz-runner entry point, seed and gen modes, usage examples, important options, module structure, and extension notes for adding new runners.
  • Expand smtfuzz/inter/README.md to list component responsibilities, supported theories, common bridge patterns (e.g. str.len, bv2nat, fp.to_real), usage scenarios, and development notes for adding new bridges.
  • Minor formatting and example additions to help reproduce and report solver failures (commands, expected artifacts to save).

Testing

  • Ran the test suite with python -m pytest smtfuzz/tests, which executed and reported the existing tests as skipped (7 tests skipped) and completed successfully.
  • Verified CLI help commands with python -m smtfuzz.cli --help, python -m smtfuzz.runner_cli --help, python -m smtfuzz.runner_cli seed --help, and python -m smtfuzz.runner_cli gen --help, all of which ran without errors.
  • Ran git diff --check (and repository checks) to ensure no trailing whitespace or diff issues; check passed.

Codex Task

@rainoftime rainoftime merged commit ebf1c5e into main May 8, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant