Improve project documentation#3
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Description
README.mdwith installation instructions (PyPI and source), quick-start examples, command-line summaries, repository layout, development guidance, and bug-reporting instructions.smtfuzz/runner/README.mdto document thesmtfuzz-runnerentry point,seedandgenmodes, usage examples, important options, module structure, and extension notes for adding new runners.smtfuzz/inter/README.mdto 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.Testing
python -m pytest smtfuzz/tests, which executed and reported the existing tests as skipped (7 tests skipped) and completed successfully.python -m smtfuzz.cli --help,python -m smtfuzz.runner_cli --help,python -m smtfuzz.runner_cli seed --help, andpython -m smtfuzz.runner_cli gen --help, all of which ran without errors.git diff --check(and repository checks) to ensure no trailing whitespace or diff issues; check passed.Codex Task