From 9c0843e69bb495d93de2a2fc03106b8cc24ca11d Mon Sep 17 00:00:00 2001
From: Christian Semmler <mail@csemmler.com>
Date: Fri, 19 Jan 2024 23:18:39 +0100
Subject: [PATCH] Update README.md [skip ci]

---
 tools/README.md | 18 +++++++++++++++---
 1 file changed, 15 insertions(+), 3 deletions(-)

diff --git a/tools/README.md b/tools/README.md
index da23d84c..75a25668 100644
--- a/tools/README.md
+++ b/tools/README.md
@@ -71,7 +71,7 @@ Synthetic functions should be annotated with `SYNTHETIC`. A synthetic function i
 // MxList<MxRegionLeftRight *>::`scalar deleting destructor'
 ```
 
-## Virtual tables (**WIP**)
+## Virtual tables
 
 Classes with a virtual table should be annotated using the `VTABLE` marker, which includes the module name and address of the virtual table. Additionally, virtual function declarations should be annotated with a comment indicating their relative offset. Please use the following example as a reference.
 
@@ -86,7 +86,7 @@ public:
 	virtual MxResult Create(MxU32 p_frequencyMS, MxBool p_createThread); // vtable+0x28
 ```
 
-## Class size (**WIP**)
+## Class size
 
 Classes should be annotated using the `SIZE` marker to indicate their size. If you are unsure about the class size in the original binary, please use the currently available information (known member variables) and detail the circumstances in an extra comment if necessary.
 
@@ -112,7 +112,7 @@ private:
 	undefined4 m_unk0x14; // 0x14
 ```
 
-## Global variables (**WIP**)
+## Global variables
 
 Global variables should be annotated using the `GLOBAL` marker, which includes the module name and address of the variable.
 
@@ -127,6 +127,18 @@ MxAtomId* g_pz5Script = NULL;
 MxAtomId* g_introScript = NULL;
 ```
 
+## Strings
+
+String values should be annotated using the `STRING` marker, which includes the module name and address of the string.
+
+```
+inline virtual const char* ClassName() const override // vtable+0x0c
+{
+	// STRING: LEGO1 0x100f03fc
+	return "Act2PoliceStation";
+}
+```
+
 # Tooling
 
 Use `pip` to install the required packages to be able to use the Python tools found in this folder: