Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

32 lines (23 loc) · 1.27 KB
Raw

Important

Anyone wanting to contribute MUST read the following and adhere to the steps outlined, in order to not violate any copyright.

This decompile is a clean room design. It MUST not incorperate any code owned by Nintendo or other third parties.

In order to achieve this, all code has to be written completely fresh, without reference to any third party code, no matter if leaked or not.

Derived from this there is the following requirement for contributors:

  • Contributors MUST NOT study or refer to any code owned by Nintendo or other third parties.

Decompiling

Before starting any decompilation, make sure the project builds correctly:

$ make check

Then these are the rough steps to decompile a function:

  1. Pick a function to decompile (from asm/disasm_*.s)
  2. Create a new file in src/ if necessary (also adjust linker.ld)
  3. Go through it, roughly line by line, and translate it into C (into the proper file in src/)
  4. Compile it, see what doesn't match, and change it
  5. Repeat step 4 until everything matches (make diff can be helpful, as well as https://cexplore.karathan.at/ and https://decomp.me/)
  6. Make sure everything still works (make check should give you OK)
  7. Open a PR on github