Readme rewrite#936
Conversation
LucretiaArc
requested review from
Reonu,
arthurtilly and
gheskett
as code owners
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).
|
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
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
gheskett
added
the
blocker
Project516
left a comment
Project516
left a comment
There was a problem hiding this comment.
Content looks good, I had some minor suggestions.
There was a problem hiding this comment.
Why not name this CREDITS.md? - CONTRIBUTORS is similar to CONTRIBUTING (https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)
| @@ -0,0 +1,22 @@ | |||
| - **ArcticJaguar725**: Most audio configuration and layout changes, colored ia4 text, floombas, various bugfixes, and more | |||
4 participants
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.