diff options
| author | Aetias <aetias@outlook.com> | 2024-04-18 18:19:52 +0200 |
|---|---|---|
| committer | Aetias <aetias@outlook.com> | 2024-04-18 18:19:52 +0200 |
| commit | d14d3113b766d15bb7b90cd8628ee85b98dec9ac (patch) | |
| tree | f17e410bbad6c409d1c2da9c5eb08bec26b16fef | |
| parent | 35528451dec9fb0fed1bdec528e6604e2d162ec2 (diff) | |
| parent | 6415abdc571f38fe7f4f24880fd93da9105a00f8 (diff) | |
Merge branch 'main' into item-manager
| -rw-r--r-- | docs/decompiling.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/decompiling.md b/docs/decompiling.md index 34333d77..2625a4c4 100644 --- a/docs/decompiling.md +++ b/docs/decompiling.md @@ -1,9 +1,22 @@ # Decompiling This document describes how you can start decompiling code and contribute to the project. Feel free to ask for help if you get stuck or need assistance. +- [Pick a source file](#pick-a-source-file) - [Decompiling a function](#decompiling-a-function) - [The Ghidra project](#the-ghidra-project) +## Pick a source file +See the `decomp` tag in the [issue tracker](https://github.com/AetiasHax/ph/issues?q=is%3Aopen+is%3Aissue+label%3Adecomp) for +a list of delinked source files that are ready to be decompiled. This list grows as more source files are delinked from the +rest of the Assembly code. + +You can claim a source file by leaving a comment on its issue, so that GitHub allows us to assign you to it. This indicates +that you are currently decompiling that source file. + +If you want to unclaim the file, leave another comment so we can be certain that the source file is available to be claimed +again. Remember to make a pull request of any notable progress you made on the source file, which can include +[non-matching functions](/CONTRIBUTING.md#non-matching-functions). + ## Decompiling a function Say you've found a function you want to decompile. Here are the steps we recommend for decompiling it: 1. Visit [decomp.me](https://decomp.me/) and start decomping. |