update docs

Author: Ughuuu

README.md

@@ -62,6 +62,21 @@ and the [godot-cpp issue tracker](https://github.com/godotengine/godot-cpp/issue
 for a list of known issues, and be sure to provide feedback on issues and PRs
 which affect your use of this extension.
 
+## Godot and Godot Cpp Compatibility
+
+If you intend to target both building as a GDExtension and as a module using godot repo, you can generate compatibility includes that will target either GDExtension or module, based on the GODOT_MODULE_COMPAT define.
+
+If you want such a thing built, when running the build command, `scons`, make sure you have a file called `output_header_mapping.json` at root level of this repo. This file needs to have the mappings from `godot` repo. The mappings can be generated by running the compat_generator.py script.
+
+Example of how to obtain them:
+
+```
+git clone godotengine/godot
+python compat_generator.py godot
+```
+
+Then run the SConstruct build command as usual, and in the `gen/` folder you will now have a new folder, `include/godot_compat` which mirrors the `include/godot_cpp` includes, but have ifdef inside them and either include godot header or godot_cpp header.
+
 ## Contributing
 
 We greatly appreciate help in maintaining and extending this project. If you

compat_generator.py

@@ -9,7 +9,7 @@ def parse_header_file(file_path):
     types = {"classes": [], "structs": []}
     # print(file_path)
 
-    with open(file_path, "r") as file:
+    with open(file_path, "r", encoding="utf-8") as file:
         content = file.read()
 
         # Regular expressions to match different types