Readme rewrite#936
Open
LucretiaArc wants to merge 4 commits into
Open
Conversation
LucretiaArc
requested review from
Reonu,
arthurtilly and
gheskett
as code owners
aglab2
reviewed
Apr 29, 2026
aglab2
reviewed
Apr 29, 2026
gheskett
reviewed
Apr 30, 2026
Collaborator
gheskett
left a comment
gheskett
left a comment
There was a problem hiding this comment.
I would maybe add a Q+A answer for when to use HackerSM64 vs ultrasm64 or something (maybe along with other common Q+A cases if we're gonna bother adding the category).
Author
|
I've added a short FAQ with only two questions for now, but if you can think of any pressing ones feel free to add/mention them. |
gheskett
approved these changes
May 1, 2026
Collaborator
gheskett
left a comment
gheskett
left a comment
There was a problem hiding this comment.
Made a few of my own additional changes. While I don't think it's perfect (probably missing a lot of things that don't come to mind atm), it's probably good enough right now at least for me.
gheskett
added
documentation
Open
gheskett
added
the
blocker
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
3 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.
Credits have been moved to CONTRIBUTORS.md, and mentions of the users that made any given change were removed. It would be best to keep that information (if kept separately from the commit log) in one place outside of the readme. This file probably needs some attention but that might be a project we defer for later in the name of readying this for 2.4.
Changes have also been shuffled around into rough categories, with mentions of many minor ones removed, since most people looking for a summary of the project aren't interested in every little change. If we want to maintain a list of features or changes, we should do that as part of a separate document. That seems like tedious work, and something that's easy to have desynchronise from the state of the project, but it could help with feature discoverability.