docs: add note in README.md about pip installing through git. #2005
Conversation
This file contains 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
jpivarski
temporarily deployed
to
docs-preview
GitHub Actions
Inactive
agoose77
approved these changes
Dec 14, 2022
jpivarski
deleted the
jpivarski/note-in-README-about-pip-install-through-git
branch
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.
I think that the only place where installation is described in enough detail to include a note about not using pip with git is on the README.
This note links to the Installation for developers section, which isn't on PyPI. The note is too detailed for PyPI, anyway.
To make that work with a single cut, I also moved the Getting started section earlier. It makes more sense for the two Installation sections to be next to each other, anyway. The Getting started is short enough that it's clear that there's an installation section immediately after it.