Skip to content

README Cleanup #846

@gheskett

Description

@gheskett

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    blockerThis MUST be resolved before the feature branch can be merged.cleanupRemoval of useless or bloat code/featuresdocumentationImprovements or additions to documentationhigh priorityImportant, non-critical issue or feature / high priority

    Type

    No type

    Projects

    Status

    To Do

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions