From b6544b73b5b0d2f600733cc39edc7b1e228c2411 Mon Sep 17 00:00:00 2001
From: Shea Frembling <78270092+sfrembling@users.noreply.github.com>
Date: Thu, 12 Feb 2026 11:09:40 -0600
Subject: [PATCH] add README (#3)

---
 README.md | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 73 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5b805e8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,73 @@
+# The Tower
+
+## Learning Resources
+
+- [Godot Docs](https://docs.godotengine.org/en/stable/index.html)
+- [GDQuest](https://www.gdquest.com/)
+
+## Branch Standards
+
+Name branches as `<you>/<topic>`
+
+Don't push to `main`
+
+Create pull requests to merge in code
+
+## Code Standards
+
+Prefer `const` instead of `var` if possible
+
+- `const` means that the variable cannot change value, while `var` means change value
+- This preference helps to keep code easier to understand and debug
+
+Use `snake_case` for variable and function names
+
+```gdscript
+var joe_mama := 10
+
+func is_joe_mama(id: int) -> bool:
+  if id == 10:
+    return true
+  else:
+    return false
+```
+
+Use `PascalCase` for class names
+
+```gdscript
+class_name PlayerController
+
+class EnemyProjectile
+```
+
+Ensure you are using types for your variables
+
+Good:
+
+```gdscript
+var x: int = 10
+var y := "Test" # := is the same as saying "y equals "Test" and is of type String"
+func add(a: int, b: int) -> int
+```
+
+Bad:
+
+```gdscript
+var x = 10
+var y = "Test"
+func add(a, b)
+```
+
+Ensure your variables and functions have descriptive names
+
+Good:
+
+```gdscript
+const PLAYER_SPEED: float = 300.0 # px/sec
+```
+
+Bad:
+
+```gdscript
+const S: 300.0
+```