summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLéo Lam <leo@leolam.fr>2022-06-21 21:55:37 +0200
committerLéo Lam <leo@leolam.fr>2022-06-21 21:55:37 +0200
commitf2ceb76ee9f20b6ce7e84f53e37b720ebcea0e9e (patch)
tree5b42b7bbed1914e85fa0384fffb5336929cf9050
parent42eaef227b591406309f016dd50bd4cedb25987d (diff)
Contributing: Mention rename_functions_in_ida.py
-rw-r--r--Contributing.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/Contributing.md b/Contributing.md
index 986a9141..ad4fbbd1 100644
--- a/Contributing.md
+++ b/Contributing.md
@@ -155,6 +155,11 @@ Note that you will need to import names and types manually and you will not be a
* If your editor does not have built-in support for clang-format, or if you need to invoke clang-format in a terminal, you'll need to install it manually.
* If your Linux distro or system (e.g. macOS) does not package clang-format 12, you can download it from [the LLVM project website here](https://releases.llvm.org/download.html)
+
+## Importing names from the decomp source code
+
+In IDA, run the `tools/common/rename_functions_in_ida.py` script (File > Script file...) to import names from the decomp source code back into the IDA database. This can be done as often as you want.
+
## Code style
BotW has 40MB of code and contributors *need* to read and modify existing parts of the codebase very often: inconsistencies lead to a loss of efficiency, and we literally cannot afford that considering our small number of contributors. To avoid wasting time on formatting issues, we use clang-format to automatically enforce a consistent coding style.