Skip to content

docs: add a Features summary to the README#29

Merged
ricardojrdez merged 1 commit into
masterfrom
docs-features-summary
Jun 23, 2026
Merged

docs: add a Features summary to the README#29
ricardojrdez merged 1 commit into
masterfrom
docs-features-summary

Conversation

@ricardojrdez

Copy link
Copy Markdown
Member

Adds a high-level Features section near the top of the README summarizing rop3's capabilities, including everything added recently:

  • multi-format / multi-arch analysis and --arch slice selection for fat Mach-O
  • ROP/JOP/RETF gadget search and search controls
  • operations and ROP chains (including composite operations)
  • --base relocation for ELF/PE/Mach-O
  • bad-char filtering on address (--badchar) and bytes (--badchar-bytes), canary-free address preference
  • --symbols annotation
  • --output text/json/csv
  • --interactive mode
  • parallel scan (--jobs) and on-disk cache (--cache)
  • the Rop3 library API

Docs-only change; the detailed usage/sections below were already documented.

Add a high-level Features section that summarizes rop3's capabilities,
including the recent additions: --arch slice selection, --badchar-bytes,
--symbols, json/csv output, interactive mode, parallel scan (--jobs),
the on-disk cache (--cache) and the Rop3 library API.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@ricardojrdez ricardojrdez merged commit 95f6cb9 into master Jun 23, 2026
3 checks passed
@ricardojrdez ricardojrdez deleted the docs-features-summary branch June 23, 2026 20:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant