Skip to content

Commit

Permalink
Contributing: Mention VSCode build type quirk
Browse files Browse the repository at this point in the history
  • Loading branch information
leoetlino committed Jun 22, 2022
1 parent 9e65e7a commit a68d10e
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions Contributing.md
Expand Up @@ -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.
Expand Down Expand Up @@ -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!
Expand Down

0 comments on commit a68d10e

Please sign in to comment.