Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move README out of .github directory so that the primary README is used #496

Merged
merged 1 commit into from
Oct 28, 2024

Conversation

drewoldag
Copy link
Collaborator

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

…directories so they are not displayed as the default for the whole repo.
@drewoldag drewoldag self-assigned this Oct 28, 2024
@drewoldag drewoldag requested review from a team, wenneman and delucchi-cmu and removed request for a team and wenneman October 28, 2024 18:15
@drewoldag drewoldag linked an issue Oct 28, 2024 that may be closed by this pull request
@drewoldag drewoldag merged commit 7baeaa4 into main Oct 28, 2024
5 checks passed
@drewoldag drewoldag deleted the issue/491/readme-in-github-dir branch October 28, 2024 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

README file in the .github directory
2 participants