falso
/
botw
mirror of https://github.com/zeldaret/botw.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Contributing: Mention VSCode build type quirk

This commit is contained in:
Léo Lam 2022-06-22 20:22:38 +02:00
parent 9e65e7a9eb
commit a68d10ec47
No known key found for this signature in database
GPG Key ID: 0DF30F9081000741
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Contributing.md
View File

@ -30,6 +30,8 @@ BotW is mostly set up like a normal C++ project using standard build tools and c
Make sure you have the C++ and the CMake Tools extensions installed and enabled. And then just answer "yes" when you're asked whether you would like CMake Tools to configure IntelliSense for you.
In certain circumstances, VSCode may silently attempt to set the build type to Debug. Make sure the build type is set to RelWithDebInfo (and not Debug); otherwise the entire build will mismatch.
### CLion
CLion interacts with CMake directly, so you need to make sure CLion's build profile is configured correctly.
@ -96,6 +98,8 @@ Note that you will need to import names and types manually and you will not be a
## How to decompile
0. Build the project and run `tools/check` to make sure the project is set up correctly. You should see "OK" at the end.
1. **Pick a function that you want to decompile.**
* Prefer choosing a function that you understand or that is already named in your IDA/Ghidra database.
* Use our [Trello project board](https://botw.link/trello) to figure out what needs to be decompiled. Make sure it's not already being worked on by somebody else!