From 018571090560c0b7c4dc774ebbbccb48e5fb9f93 Mon Sep 17 00:00:00 2001
From: paladin <christian.lincoln25@ic.ac.uk>
Date: Wed, 19 Aug 2026 23:50:27 +0100
Subject: [PATCH] Added README.md introducing the engine and it's aims

---
 .idea/.gitignore                             | 10 ++++++++++
 .idea/Pool.iml                               | 17 +++++++++++++++++
 .idea/codeStyles/codeStyleConfig.xml         |  5 +++++
 .idea/dictionaries/project.xml               |  8 ++++++++
 .idea/inspectionProfiles/Project_Default.xml |  5 +++++
 .idea/modules.xml                            |  8 ++++++++
 .idea/vcs.xml                                |  6 ++++++
 README.md                                    |  7 +++++++
 8 files changed, 66 insertions(+)
 create mode 100644 .idea/.gitignore
 create mode 100644 .idea/Pool.iml
 create mode 100644 .idea/codeStyles/codeStyleConfig.xml
 create mode 100644 .idea/dictionaries/project.xml
 create mode 100644 .idea/inspectionProfiles/Project_Default.xml
 create mode 100644 .idea/modules.xml
 create mode 100644 .idea/vcs.xml
 create mode 100644 README.md

diff --git a/.idea/.gitignore b/.idea/.gitignore
new file mode 100644
index 0000000..30cf57e
--- /dev/null
+++ b/.idea/.gitignore
@@ -0,0 +1,10 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Ignored default folder with query files
+/queries/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml
diff --git a/.idea/Pool.iml b/.idea/Pool.iml
new file mode 100644
index 0000000..0cd351f
--- /dev/null
+++ b/.idea/Pool.iml
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="EMPTY_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/stupid_display/src" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/src/mars/src" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/lang/src" isTestSource="false" />
+      <excludeFolder url="file://$MODULE_DIR$/stupid_display/target" />
+      <excludeFolder url="file://$MODULE_DIR$/target" />
+      <excludeFolder url="file://$MODULE_DIR$/src/mars/target" />
+      <excludeFolder url="file://$MODULE_DIR$/lang/target" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>
\ No newline at end of file
diff --git a/.idea/codeStyles/codeStyleConfig.xml b/.idea/codeStyles/codeStyleConfig.xml
new file mode 100644
index 0000000..a55e7a1
--- /dev/null
+++ b/.idea/codeStyles/codeStyleConfig.xml
@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="PREFERRED_PROJECT_CODE_STYLE" value="Default" />
+  </state>
+</component>
\ No newline at end of file
diff --git a/.idea/dictionaries/project.xml b/.idea/dictionaries/project.xml
new file mode 100644
index 0000000..4c3305b
--- /dev/null
+++ b/.idea/dictionaries/project.xml
@@ -0,0 +1,8 @@
+<component name="ProjectDictionaryState">
+  <dictionary name="project">
+    <words>
+      <w>forloop</w>
+      <w>vmcase</w>
+    </words>
+  </dictionary>
+</component>
\ No newline at end of file
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
new file mode 100644
index 0000000..8d66637
--- /dev/null
+++ b/.idea/inspectionProfiles/Project_Default.xml
@@ -0,0 +1,5 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+  </profile>
+</component>
\ No newline at end of file
diff --git a/.idea/modules.xml b/.idea/modules.xml
new file mode 100644
index 0000000..c51517b
--- /dev/null
+++ b/.idea/modules.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/Pool.iml" filepath="$PROJECT_DIR$/.idea/Pool.iml" />
+    </modules>
+  </component>
+</project>
\ No newline at end of file
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
new file mode 100644
index 0000000..35eb1dd
--- /dev/null
+++ b/.idea/vcs.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a52876f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+The Pool engine. Hop in, the water is warm.
+
+Pool is a lightweight web-based networked rendering and physics engine designed to push the boundaries of what defines a
+modern engine.
+
+Pool was inspired by the Roblox game engine and features its own scripting language. Global fluid, cloth, soft and rigid
+body physics are intended to be implemented in the near future.
\ No newline at end of file