From a68d10ec477df91acf6bab63a316cd8ab954e7a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Lam?= Date: Wed, 22 Jun 2022 20:22:38 +0200 Subject: [PATCH] Contributing: Mention VSCode build type quirk --- Contributing.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Contributing.md b/Contributing.md index 7e581ccf..23fac62d 100644 --- a/Contributing.md +++ b/Contributing.md @@ -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!