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.

Sign up for GitHub

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

Jump to bottom

README Cleanup #846

Open
gheskett opened this issue Dec 13, 2024 · 0 comments
Open

README Cleanup #846

gheskett opened this issue Dec 13, 2024 · 0 comments
Labels
cleanup Removal of useless or bloat code/features documentation Improvements or additions to documentation high priority Important, non-critical issue or feature / high priority
Milestone
2.4

Comments

@gheskett
Copy link
Collaborator

The README is currently very outdated and is a nightmare to sift through. It contains swaths of info about patches/defines (that are now too plentiful to exist in a README) and lacks mention of things that actually should belong in a README (like linking to the HackerSM64 installation Wiki). The legacy UltraSM64 README also bloats it a fair amount with very little added value at this point.

There is some subjectivity to this, such as how we'd want to approach cleaning up credits and where to put information about changes to the base game (especially ones not covered by defines). We'd also need to pool together some effort on that front to mention important changes that currently aren't present in the existing README.
@gheskett gheskett added documentation Improvements or additions to documentation high priority Important, non-critical issue or feature / high priority cleanup Removal of useless or bloat code/features labels Dec 13, 2024
@gheskett gheskett added this to the 2.4 milestone Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
cleanup Removal of useless or bloat code/features documentation Improvements or additions to documentation high priority Important, non-critical issue or feature / high priority
Projects
2.4 (Minor Feature Update)
Status: No status
Milestone
2.4
Development

No branches or pull requests
1 participant
@gheskett