Add READMEs to all subsystems

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)

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.

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.

graphics/opengl/README.md

@@ -0,0 +1,2 @@
+# The `opengl` subsystem
+This subsystem is a Graphics API, bringing OpenGL into the engine.

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.

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.

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.