diff --git a/README.md b/README.md index 145ce01..a6fd09f 100644 --- a/README.md +++ b/README.md @@ -37,4 +37,18 @@ void Name__Space__Thing(); # Symbol files -Symbol files are text files that map function names and data labels to addresses. \ No newline at end of file +Symbol files are text files that map function names and data labels to addresses. + +In this repo, `script/compile-symbols` is used to concatenate our organized symbol files into one big file (`/symbol/main.sym`). + +To import this file to your Ghidra project, + + 1. go to `Window` > `Script Manager` + 2. In the table view, lookup `ImportSymbolsScript.py` + 3. Run the script + 4. Enter the path to `/symbol/main.sym` + +To refresh the `main.sym` file after changing one of the constituent symbol files: + +```bash +script/compile-symbols \ No newline at end of file