Merged
Conversation
cjolowicz
force-pushed
the
remove-quickstart-from-readme
branch
from
6626526 to
264ca9c
Compare
The README on the GitHub repository page reflects the state of the master branch, instead of the stable release. To reduce potential confusion, it's better to keep the README short, and omit the Quickstart content. This content is still available on Read the Docs, and now lives in quickstart.rst itself, instead of being included from the README. The README now consists of the badges, the logo, the usage, and the list of features. Sphinx references are spread out over the README, the Quickstart Guide, and the User Guide, with each of these including references from its predecessors.
cjolowicz
force-pushed
the
remove-quickstart-from-readme
branch
from
264ca9c to
bccb231
Compare
Merged
paw-lu
pushed a commit
to paw-lu/cookiecutter-hypermodern-python
that referenced
this pull request
Mar 8, 2021
The README on the GitHub repository page reflects the state of the master branch, instead of the stable release. To reduce potential confusion, it's better to keep the README short, and omit the Quickstart content. This content is still available on Read the Docs, and now lives in quickstart.rst itself, instead of being included from the README. The README now consists of the badges, the logo, the usage, and the list of features. Sphinx references are spread out over the README, the Quickstart Guide, and the User Guide, with each of these including references from its predecessors.
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
1 participant
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 README on the GitHub repository page reflects the state of the master branch, instead of the stable release. To reduce potential confusion, it's better to keep the README short, and omit the Quickstart content. This content is still available on Read the Docs, and now lives in quickstart.rst itself, instead of being included from the README.
The README now consists of the badges, the logo, the usage, and the list of features. Sphinx references are spread out over the README, the Quickstart Guide, and the User Guide, with each of these including references from its predecessors.