From f40ba7f27e226ec5e14e9e88ddd0649dbabfadc1 Mon Sep 17 00:00:00 2001
From: Eric-Paul Ickhorn <ericp.ickhorn@gmail.com>
Date: Sat, 7 Sep 2024 22:11:10 +0200
Subject: [PATCH] Add module skeletons

The "skeletons" of the modules contain a README explaining what it is
about and an includes.txt which is used by the build-script.
---
 modules/assets/README.md      | 4 ++++
 modules/assets/includes.txt   | 3 +++
 modules/ecs/README.md         | 4 ++++
 modules/ecs/includes.txt      | 2 ++
 modules/renderer/README.md    | 4 ++++
 modules/renderer/includes.txt | 4 ++++
 modules/utility/README.md     | 3 +++
 modules/utility/includes.txt  | 1 +
 modules/window/README.md      | 4 ++++
 modules/window/includes.txt   | 3 +++
 modules/world/README.md       | 4 ++++
 modules/world/includes.txt    | 2 ++
 12 files changed, 38 insertions(+)
 create mode 100644 modules/assets/README.md
 create mode 100644 modules/assets/includes.txt
 create mode 100644 modules/ecs/README.md
 create mode 100644 modules/ecs/includes.txt
 create mode 100644 modules/renderer/README.md
 create mode 100644 modules/renderer/includes.txt
 create mode 100644 modules/utility/README.md
 create mode 100644 modules/utility/includes.txt
 create mode 100644 modules/window/README.md
 create mode 100644 modules/window/includes.txt
 create mode 100644 modules/world/README.md
 create mode 100644 modules/world/includes.txt

diff --git a/modules/assets/README.md b/modules/assets/README.md
new file mode 100644
index 0000000..6b5ddc1
--- /dev/null
+++ b/modules/assets/README.md
@@ -0,0 +1,4 @@
+# Voxula Assets
+
+The Voxula Asset Manager is able to load multiple data formats and can
+store the data they contain in a way efficient to manage.
diff --git a/modules/assets/includes.txt b/modules/assets/includes.txt
new file mode 100644
index 0000000..7870910
--- /dev/null
+++ b/modules/assets/includes.txt
@@ -0,0 +1,3 @@
+{self}/inc-c
+{module-folder}/utility/inc-c
+{module-folder}/ecs/inc-c
\ No newline at end of file
diff --git a/modules/ecs/README.md b/modules/ecs/README.md
new file mode 100644
index 0000000..c37cc25
--- /dev/null
+++ b/modules/ecs/README.md
@@ -0,0 +1,4 @@
+# Voxula ECS
+
+The Voxula ECS (Vex) is a highly performant ECS (Entity Component
+System), it helps with managing data.
diff --git a/modules/ecs/includes.txt b/modules/ecs/includes.txt
new file mode 100644
index 0000000..778beaa
--- /dev/null
+++ b/modules/ecs/includes.txt
@@ -0,0 +1,2 @@
+{self}/inc-c
+{module-folder}/utility/inc-c
\ No newline at end of file
diff --git a/modules/renderer/README.md b/modules/renderer/README.md
new file mode 100644
index 0000000..e7c3b36
--- /dev/null
+++ b/modules/renderer/README.md
@@ -0,0 +1,4 @@
+# Voxula Renderer
+
+The Voxula renderer is a system to render voxels in an efficient way
+and to produce a visually appealing image.
diff --git a/modules/renderer/includes.txt b/modules/renderer/includes.txt
new file mode 100644
index 0000000..06d6217
--- /dev/null
+++ b/modules/renderer/includes.txt
@@ -0,0 +1,4 @@
+{self}/inc-c
+{module-folder}/utility/inc-c
+{module-folder}/window/inc-c
+{module-folder}/ecs/inc-c
\ No newline at end of file
diff --git a/modules/utility/README.md b/modules/utility/README.md
new file mode 100644
index 0000000..6e97319
--- /dev/null
+++ b/modules/utility/README.md
@@ -0,0 +1,3 @@
+# Voxula Utility
+
+Miscellaneous Utilities used throughout the Voxula Engine.
diff --git a/modules/utility/includes.txt b/modules/utility/includes.txt
new file mode 100644
index 0000000..39ebc60
--- /dev/null
+++ b/modules/utility/includes.txt
@@ -0,0 +1 @@
+{self}/inc-c
\ No newline at end of file
diff --git a/modules/window/README.md b/modules/window/README.md
new file mode 100644
index 0000000..806b1d0
--- /dev/null
+++ b/modules/window/README.md
@@ -0,0 +1,4 @@
+# Voxula Display Interaction
+
+This module contains code for opening windows or other means of
+displaying applications written with Voxula.
diff --git a/modules/window/includes.txt b/modules/window/includes.txt
new file mode 100644
index 0000000..7870910
--- /dev/null
+++ b/modules/window/includes.txt
@@ -0,0 +1,3 @@
+{self}/inc-c
+{module-folder}/utility/inc-c
+{module-folder}/ecs/inc-c
\ No newline at end of file
diff --git a/modules/world/README.md b/modules/world/README.md
new file mode 100644
index 0000000..7b60e0d
--- /dev/null
+++ b/modules/world/README.md
@@ -0,0 +1,4 @@
+# Voxula World (De-)Serializer
+
+The code in this directory is used for serializing and deserializing
+worlds in Voxula's World Format.
diff --git a/modules/world/includes.txt b/modules/world/includes.txt
new file mode 100644
index 0000000..778beaa
--- /dev/null
+++ b/modules/world/includes.txt
@@ -0,0 +1,2 @@
+{self}/inc-c
+{module-folder}/utility/inc-c
\ No newline at end of file