Skip to content

docs: cleanup/rewrite#37

Merged
bghira merged 1 commit into
mainfrom
agent/markdown-facts-cleanup
Jul 17, 2026
Merged

docs: cleanup/rewrite#37
bghira merged 1 commit into
mainfrom
agent/markdown-facts-cleanup

Conversation

@bghira

@bghira bghira commented Jul 17, 2026

Copy link
Copy Markdown
Owner

This pull request updates both the README.md and BENCHMARKS.md files to provide clearer, more concise, and better-structured documentation for users and contributors. The changes focus on improving usability by clarifying installation steps, usage examples, API descriptions, implementation details, and benchmark instructions, while removing outdated or redundant information.

Documentation and usability improvements:

  • Major rewrite of README.md to provide a concise project overview, clearer install instructions for both Python and Rust, and practical usage examples for each language. The new format uses tables for API and implementation details, and removes redundant or outdated sections.
  • Updated the Python API documentation to use tables for function signatures, input/output types, and constraints, making it easier to find and understand available functions and their requirements.
  • Added a Rust usage example with a minimal, idiomatic code snippet, and clarified the feature set and build requirements for both Python and Rust users.
  • Simplified and reorganized the BENCHMARKS.md file to focus on how to run benchmarks, what is measured, and how to interpret results. Removed point-in-time timing tables and replaced them with instructions for saving and annotating results, as well as tables describing measured operations and comparison constraints.
  • Added sections to both files that clarify limitations, input requirements, and the non-drop-in nature of the Python API compared to OpenCV, helping set correct expectations for new users. [1] [2]

@bghira
bghira merged commit 4c0cdf3 into main Jul 17, 2026
0 of 10 checks passed
@bghira
bghira deleted the agent/markdown-facts-cleanup branch July 17, 2026 16:59
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