đź“ť Docs: README lacks installation and usage guidance#34936
Open
letho1608 wants to merge 1 commit intoopenvinotoolkit:masterfrom
Open
đź“ť Docs: README lacks installation and usage guidance#34936letho1608 wants to merge 1 commit intoopenvinotoolkit:masterfrom
letho1608 wants to merge 1 commit intoopenvinotoolkit:masterfrom
Conversation
The top‑level README provides only a logo, key‑feature links, and badges. It does not contain any instructions on how to install the OpenVINO Toolkit (pip, conda, Docker, source build), nor does it give a quick‑start example or a link to the API reference. New contributors and users will be unable to get the library up and running from the README alone. Affected files: README.md Signed-off-by: Le Quang Tho <92069270+letho1608@users.noreply.github.com>
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
2 participants
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.
đź“ť Documentation
Problem
The top‑level README provides only a logo, key‑feature links, and badges. It does not contain
any instructions on how to install the OpenVINO Toolkit (pip, conda, Docker, source build),
nor does it give a quick‑start example or a link to the API reference. New contributors
and users will be unable to get the library up and running from the README alone.
Severity:
highFile:
READMESolution
Add a dedicated “Installation” section that lists the supported installation methods
(pip, conda, Docker, source) with example commands. Follow it with a “Quick Start”
section that shows a minimal inference script and a “API Reference” link to the
autogenerated docs. Example snippet:
Changes
README.md(modified)Details:
Tickets:
AI Assistance:
🤖 About this PR
This pull request was generated by ContribAI, an AI agent
that helps improve open source projects. The change was:
If you have questions or feedback about this PR, please comment below.
We appreciate your time reviewing this contribution!
Closes #34935