Improve advanced contribution readme and experience #2107
Merged
Conversation
This file contains 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
Some improvements for helping new contributors get started with the more advanced hacking aspects of the randomizer, and simplifying re-setting up an environment on new hardware/installs for existing contributors. README.md & others: Consistently use Project64's canonical name in documentation. ASM/README.md: Add headers, more detailed instructions on installing the toolchain, including methods described in Discord #dev-resources channels. Also mention a potential issue with trying to use the Project64 symbols on a default install. ASM/build.py: Add additional subdirectories of `tools` to PATH. Makes above instructions simpler. ASM/.gitignore: Ignore everything in the `tools` directory (except .gitkeep as with roms)
fenhl
added
the
Component: Documentation
Windows: armips requires the VC++ redist installed but doesn't currently provide it. MSYS2 is required for the files prepackaged on dropbox. The rest is mostly stuff people on the affected platforms should be used to so detail is not added.
Mention the compilers required on other platforms for armips as well.
cjohnson57
requested changes
Nov 13, 2023
cjohnson57
added
Status: Waiting for Author
Typo and reword previous commit.
cjohnson57
approved these changes
Nov 14, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Some improvements for helping new contributors get started with the more advanced hacking aspects of the randomizer, and simplifying re-setting up an environment on new hardware/installs for existing contributors.
README.md & others: Consistently use Project64's canonical name in documentation.
ASM/README.md: Add headers, more detailed instructions on installing the toolchain, including methods described in Discord #dev-resources channels. Also mention a potential issue with trying to use the Project64 symbols on a default install.
ASM/build.py: Add additional subdirectories of
toolsto PATH. Makes above instructions simpler.ASM/.gitignore: Ignore everything in the
toolsdirectory (except.gitkeepas withroms)2023-10-08: Added some more Windows prerequisites and details on installing MSYS2 and adding its binaries to the path. Also some quick mentions of prerequisites for other platforms.