forked from StarOpenSource/Engine
Add READMEs to all subsystems
This commit is contained in:
parent
72a13adbcd
commit
f39223b4da
7 changed files with 13 additions and 1 deletions
|
@ -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)
|
||||
|
|
2
base/README.md
Normal file
2
base/README.md
Normal file
|
@ -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.
|
2
graphics/README.md
Normal file
2
graphics/README.md
Normal file
|
@ -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.
|
2
graphics/opengl/README.md
Normal file
2
graphics/opengl/README.md
Normal file
|
@ -0,0 +1,2 @@
|
|||
# The `opengl` subsystem
|
||||
This subsystem is a Graphics API, bringing OpenGL into the engine.
|
2
graphics/vulkan/README.md
Normal file
2
graphics/vulkan/README.md
Normal file
|
@ -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.
|
2
slf4j-compat/README.md
Normal file
2
slf4j-compat/README.md
Normal file
|
@ -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.
|
2
testapp/README.md
Normal file
2
testapp/README.md
Normal file
|
@ -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.
|
Loading…
Reference in a new issue