-
Notifications
You must be signed in to change notification settings - Fork 671
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
Docs: SM64 Guide update to explain how to launch the game with batch files #768
Conversation
Added several sections in regards to opening the completed SM64 build with batch files instead of SM64PCLauncher.
I now realize my use of headers is backwards and doesn't make much sense. "Using Batch Files to play offline and MultiWorld games" should probably use "#" while the other three use "##". But I'll leave that formatting up to others' discretion on what looks best. |
Yeah please do swap those as it'll be difficult to read like this on the site. |
Made some changes in regards to the headers as well as the paragraphs in the second section, since apparently single-linebreaks result in no linebreak meaning a single jumbled paragraph I wasn't aware of previously. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I mean that's not this PR's fault, but the headers in this seem all wrong.
## Installation and Game Start Procedures
# Installation via sm64pclauncher (For Windows)
This should probably be
## Installation and Game Start Procedures
### Installation via sm64pclauncher (For Windows)
? Someone actually playing this game wants to clean that all up? :D
@Qwazzy Not a comment on the content of the pull request, but please prefix pull request titles with "[Game name abbreviation]: ", or in cases like this, "Docs: " prefix is good with the game name abbreviation later in the title, so people can find it! And I'd suggest a very brief indication of the effect of the PR could be good instead of "Update file_name.ext" if you can come up with one. (Note, once merged, sometimes PR titles end up directly at the top of the commit message in the git log, where all this summarization and categorization is quite helpful in the long-term as well.) Thanks! |
Thanks for the tip. Never did a pull request before so changing the title hadn't occurred to me as an important detail. |
@N00byKing looks good to you? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! Just a few things I was tempted to revise for flow, clarity to non-native speakers, and consistency with other guides I've edited or started edits for. :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other than what's noted should be fine.
@Qwazzy do you want to move this forward? There are a lot of unresolved suggestions. |
Honestly, it’s been awhile and this has gotten away from me a fair bit. Doing stuff via GitHub still confuses me. If anyone else wants to tidy this up, or even cancel it, feel free. |
Co-authored-by: Yussur Mustafa Oraji <[email protected]> Co-authored-by: SoldierofOrder <[email protected]>
matches the original suggestion from SoldierofOrder
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All requested changes were merged
…files (ArchipelagoMW#768) * Update setup_en.md Added several sections in regards to opening the completed SM64 build with batch files instead of SM64PCLauncher. * Update setup_en.md * Update setup_en.md * Update setup_en.md * Update setup_en.md * Apply suggestions from code review Co-authored-by: Yussur Mustafa Oraji <[email protected]> Co-authored-by: SoldierofOrder <[email protected]> * Apply more suggestions from code review matches the original suggestion from SoldierofOrder --------- Co-authored-by: black-sliver <[email protected]> Co-authored-by: Yussur Mustafa Oraji <[email protected]> Co-authored-by: SoldierofOrder <[email protected]>
…files (ArchipelagoMW#768) * Update setup_en.md Added several sections in regards to opening the completed SM64 build with batch files instead of SM64PCLauncher. * Update setup_en.md * Update setup_en.md * Update setup_en.md * Update setup_en.md * Apply suggestions from code review Co-authored-by: Yussur Mustafa Oraji <[email protected]> Co-authored-by: SoldierofOrder <[email protected]> * Apply more suggestions from code review matches the original suggestion from SoldierofOrder --------- Co-authored-by: black-sliver <[email protected]> Co-authored-by: Yussur Mustafa Oraji <[email protected]> Co-authored-by: SoldierofOrder <[email protected]>
Added several sections in regards to opening the completed SM64 build with batch files instead of SM64PCLauncher.