From f39223b4da5cb5a502aec83b288d2e0b349ee794 Mon Sep 17 00:00:00 2001
From: JeremyStarTM <jeremystartm@staropensource.de>
Date: Thu, 27 Jun 2024 20:25:32 +0200
Subject: [PATCH] Add READMEs to all subsystems

---
 README.md                 | 2 +-
 base/README.md            | 2 ++
 graphics/README.md        | 2 ++
 graphics/opengl/README.md | 2 ++
 graphics/vulkan/README.md | 2 ++
 slf4j-compat/README.md    | 2 ++
 testapp/README.md         | 2 ++
 7 files changed, 13 insertions(+), 1 deletion(-)
 create mode 100644 base/README.md
 create mode 100644 graphics/README.md
 create mode 100644 graphics/opengl/README.md
 create mode 100644 graphics/vulkan/README.md
 create mode 100644 slf4j-compat/README.md
 create mode 100644 testapp/README.md

diff --git a/README.md b/README.md
index cba70663..95ca8b60 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
 # StarOpenSource Engine
-The StarOpenSource engine (or sos!engine for short) is a modular, extensible and easy to use Java game and application engine.
+The StarOpenSource Engine (or sos!engine for short) is a modular, extensible and easy to use Java game and application engine.
 
 ## Index
 - [About](#about)
diff --git a/base/README.md b/base/README.md
new file mode 100644
index 00000000..bee8c927
--- /dev/null
+++ b/base/README.md
@@ -0,0 +1,2 @@
+# The `base` subsystem
+This is not just a subsystem, this is the core engine. It contains data types, logging infrastructure, an event system, a crash reporter and much more stuff required for basic applications.
diff --git a/graphics/README.md b/graphics/README.md
new file mode 100644
index 00000000..84cfab8e
--- /dev/null
+++ b/graphics/README.md
@@ -0,0 +1,2 @@
+# The `graphics` subsystem
+This subsystem is essential for displaying graphics to the screen, though requires a Graphics API to do anything. It provides among other things interfaces that Graphics APIs can implement.
diff --git a/graphics/opengl/README.md b/graphics/opengl/README.md
new file mode 100644
index 00000000..ed74c4a2
--- /dev/null
+++ b/graphics/opengl/README.md
@@ -0,0 +1,2 @@
+# The `opengl` subsystem
+This subsystem is a Graphics API, bringing OpenGL into the engine.
diff --git a/graphics/vulkan/README.md b/graphics/vulkan/README.md
new file mode 100644
index 00000000..24505370
--- /dev/null
+++ b/graphics/vulkan/README.md
@@ -0,0 +1,2 @@
+# The `vulkan` subsystem
+This subsystem is a Graphics API, bringing Vulkan into the engine. This Graphics API does not work at the moment.
diff --git a/slf4j-compat/README.md b/slf4j-compat/README.md
new file mode 100644
index 00000000..fbca2872
--- /dev/null
+++ b/slf4j-compat/README.md
@@ -0,0 +1,2 @@
+# The `slf4j-compat` subsystem
+This subsystem provides compatibility with [SLF4J] and redirects all log calls to the engine's own logger.
diff --git a/testapp/README.md b/testapp/README.md
new file mode 100644
index 00000000..67020b26
--- /dev/null
+++ b/testapp/README.md
@@ -0,0 +1,2 @@
+# The development application
+It is used during development to test out new stuff. It should not be used an example application.