Repository navigation
docs(readme): quickstart clones the repo (no 'conformance' PyPI trap) + badges - #3
Merged
Merged
Conversation
The quickstart showed 'pip install vitnify; python -m conformance' with no clone step. python -m conformance runs from THIS repo -- there is no 'conformance' package on PyPI (installing one would grab an unrelated stranger's package). Show the git clone + cd, and note explicitly that no 'conformance' PyPI package is needed. Add CI + license badges.
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.
The quickstart showed:
with no clone step.
python -m conformanceruns from this repo — there is noconformancepackage on PyPI, so a user following the quickstart literally either fails or (worse)pip install conformancegrabs an unrelated stranger's package. Fixed to showgit clone … && cd conformance, with an explicit note that noconformancePyPI package is required. Also adds CI + license badges.