소스 검색

Add basic module description

Patrick-Christopher Mattulat 1 개월 전
부모
커밋
81d2fc4215
2개의 변경된 파일16개의 추가작업 그리고 0개의 파일을 삭제
  1. 13 0
      README.md
  2. 3 0
      library/README.md

+ 13 - 0
README.md

@@ -1 +1,14 @@
 # Atlantis Game Engine
+
+This is a 2D game engine based on SDL3. 
+
+## Modules
+
+It contains the following modules:
+
+| Name                  | Description                                                                                              |
+|-----------------------|----------------------------------------------------------------------------------------------------------|
+| ls-atlantis-input     | This module provides all functionalities for input devices.                                              |
+| ls-atlantis-logic     | This module provides functionalities like engine setup, game loop logic and engine run time information. |
+| ls-atlantis-rendering | This module provides all rendering functionalities.                                                      |
+

+ 3 - 0
library/README.md

@@ -0,0 +1,3 @@
+# Library Directory
+
+In this directory all third party libraries are stored.