Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
toasterparty committed May 16, 2024
1 parent fb7e87c commit 43b53f2
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,24 @@ Updates to this program are documented as part of the [py-randomprime Release Pr

That should create a standalone executable in `./randomprime/target/debug/randomprime_patcher.exe`.

Occasionally run `rustup update` to keep your toolchain version up-to-date.

## Contributing

In order to pass this project's Pull Request requirements, your proposed change must pass the following checks:

```sh
cargo fmt --check
cargo clippy -- -D warnings
```

You can use these commands to fix most issues automatically:

```sh
cargo fmt
cargo clippy --fix --allow-dirty
```

## Resources

Some helpful resources for those starting out with modding Metroid Prime can be found in the [Metroid Prime Fanhacks](https://github.com/toasterparty/metroid-prime-fanhacks/tree/main/doc#resources) repository. Furthermore there's:
Expand Down

0 comments on commit 43b53f2

Please sign in to comment.