Move README out of .github directory so that the primary README is used#496
Merged
drewoldag merged 1 commit intomainlincc-frameworks/python-project-template:mainfrom Oct 28, 2024
issue/491/readme-in-github-dirlincc-frameworks/python-project-template:issue/491/readme-in-github-dirCopy head branch name to clipboard
Merged
Move README out of .github directory so that the primary README is used#496drewoldag merged 1 commit intomainlincc-frameworks/python-project-template:mainfrom issue/491/readme-in-github-dirlincc-frameworks/python-project-template:issue/491/readme-in-github-dirCopy head branch name to clipboard
.github directory so that the primary README is used#496drewoldag merged 1 commit intomainlincc-frameworks/python-project-template:mainfrom
issue/491/readme-in-github-dirlincc-frameworks/python-project-template:issue/491/readme-in-github-dirCopy head branch name to clipboard
Conversation
…directories so they are not displayed as the default for the whole repo.
delucchi-cmu
approved these changes
Oct 28, 2024
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.
Splitting the README in the .github directory into two smaller READMEs and putting them in subdirectories so they are not displayed as the default for the whole repo.
Turns out this behavior is not a bug, but a feature, and is documented here: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes#about-readmes