aboutsummaryrefslogtreecommitdiff
path: root/docs/contribution/debugging.md
diff options
context:
space:
mode:
author George L. Albany <Megacake1234@gmail.com>2023-09-25 07:26:57 +0200
committer GitHub <noreply@github.com>2023-09-25 07:26:57 +0200
commit24e9f25fe2be11f03a1588e434e0e6fe3f484144 (patch)
tree48e2b2d22cea391ca4b653a8fd2a351657f1b630 /docs/contribution/debugging.md
parenta579fa30b9faced48499028f32e3ae53d7eeb142 (diff)
parent60b62e370ee566010f88e65df3981125dc17be2d (diff)
Merge pull request #156 from Spartan322/fixup/docs
Diffstat (limited to 'docs/contribution/debugging.md')
-rw-r--r--docs/contribution/debugging.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/contribution/debugging.md b/docs/contribution/debugging.md
new file mode 100644
index 0000000..e788c44
--- /dev/null
+++ b/docs/contribution/debugging.md
@@ -0,0 +1,12 @@
+# Debugging
+
+For debugging, foremost you must:
+
+1. Build the extension with dev_build, it is also recommended to include debug_symbols. To do so run `scons dev_build=yes debug_symbols=yes`.
+
+2. Attach a debugger to Godot:
+ * For VSCode this has been mostly setup for you, in `.vscode/launch.json` just set `configuration.program` to your Godot binary path.
+
+ * For Visual Studio: TODO
+
+3. Run the task with the debugger attached. \ No newline at end of file