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.

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

Merged
merged 7 commits into from
Mar 12, 2023

Conversation

Qwazzy
Copy link
Contributor

@Qwazzy Qwazzy commented Jul 11, 2022

Added several sections in regards to opening the completed SM64 build with batch files instead of SM64PCLauncher.

Added several sections in regards to opening the completed SM64 build with batch files instead of SM64PCLauncher.
@Qwazzy
Copy link
Contributor Author

Qwazzy commented Jul 11, 2022

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.

@alwaysintreble
Copy link
Collaborator

Yeah please do swap those as it'll be difficult to read like this on the site.

@Qwazzy
Copy link
Contributor Author

Qwazzy commented Jul 14, 2022

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.

Copy link
Member

@black-sliver black-sliver left a 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

@strotlog
Copy link
Contributor

@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!

@Qwazzy Qwazzy changed the title Update setup_en.md Docs: SM64 Guide update to explain how to launch the game with batch files Jul 24, 2022
@Qwazzy
Copy link
Contributor Author

Qwazzy commented Jul 24, 2022

Thanks for the tip. Never did a pull request before so changing the title hadn't occurred to me as an important detail.

@black-sliver black-sliver added the is: documentation Improvements or additions to documentation. label Jul 28, 2022
@Berserker66
Copy link
Member

@N00byKing looks good to you?

Copy link
Contributor

@SoldierofOrder SoldierofOrder left a 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. :)

worlds/sm64ex/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/sm64ex/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/sm64ex/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/sm64ex/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/sm64ex/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/sm64ex/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/sm64ex/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/sm64ex/docs/setup_en.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@N00byKing N00byKing left a 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.

worlds/sm64ex/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/sm64ex/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/sm64ex/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/sm64ex/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/sm64ex/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/sm64ex/docs/setup_en.md Outdated Show resolved Hide resolved
@black-sliver
Copy link
Member

@Qwazzy do you want to move this forward? There are a lot of unresolved suggestions.

@Qwazzy
Copy link
Contributor Author

Qwazzy commented Mar 11, 2023

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
Copy link
Member

@black-sliver black-sliver left a 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

@black-sliver black-sliver merged commit 4bc0e84 into ArchipelagoMW:main Mar 12, 2023
kindasneaki pushed a commit to kindasneaki/Archipelago that referenced this pull request Jun 28, 2023
…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]>
FlySniper pushed a commit to FlySniper/Archipelago that referenced this pull request Nov 14, 2023
…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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
is: documentation Improvements or additions to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants