feat(docs): more documentation

KomodoPlatform · Oct 2, 2019 · 9048f6d · 9048f6d
1 parent 8054de9
commit 9048f6d
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -18,6 +18,15 @@ Icon
 # Thumbnails
 ._*
 
+
+# Extras
+examples/sfml/flappy-bird-scripted/assets/scripts/systems/lua/scenes_system.lua
+modules/lua/assets/lua_assets/scripts/systems/scenes_system.lua
+antara-gaming-sdk.srctrlbm
+antara-gaming-sdk.srctrldb
+antara-gaming-sdk.srctrlprj
+
+
 # Files that might appear in the root of a volume
 .DocumentRevisions-V100
 .fseventsd

diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
@@ -63,6 +63,7 @@ add_custom_command(OUTPUT ${SPHINX_INDEX_FILE}
         ${CMAKE_CURRENT_SOURCE_DIR}/source/api/api_index.rst
         ${CMAKE_CURRENT_SOURCE_DIR}/source/api/core.rst
         ${CMAKE_CURRENT_SOURCE_DIR}/source/api/config.rst
+        ${CMAKE_CURRENT_SOURCE_DIR}/source/modules/modules.rst
         ${CMAKE_CURRENT_SOURCE_DIR}/source/tutorials/tutorials.rst
         ${CMAKE_CURRENT_SOURCE_DIR}/source/tutorials/quick_and_dirty.rst
         ${DOXYGEN_INDEX_FILE}

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,11 +1,22 @@
 Welcome to antara-gaming-sdk documentation !
 ============================================
+
+Introduction
+------------
+
+Welcome to the documentation of the antara-gaming-sdk.
+``antara-gaming-sdk`` is an SDK programmed in **C++ 17** that aims to be very fast in runtime by using the maximum of features at the compilation while remaining extensible to the runtime.
+It is based on an architecture of modules that can be used separately or together.
+
+Below a list of topics covered by the documentation:
+
 .. toctree::
    :maxdepth: 1
    :name: index
 
    source/api/api_index
    source/tutorials/tutorials
+   source/modules/modules
 
 
 Indices and tables

diff --git a/docs/source/api/api_index.rst b/docs/source/api/api_index.rst
@@ -1,4 +1,4 @@
-antara-gaming-sdk API documentation
+Antara Gaming API documentation
 ======================================
 
 .. toctree::

diff --git a/docs/source/modules/modules.rst b/docs/source/modules/modules.rst
@@ -0,0 +1,3 @@
+Antara Gaming Modules
+=====================
+
diff --git a/docs/source/tutorials/tutorials.rst b/docs/source/tutorials/tutorials.rst
@@ -1,4 +1,4 @@
-Tutorials
+Antara Gaming Tutorials
 ============================================
 
 .. toctree::

diff --git a/examples/quick_and_dirty/quick_and_dirty.cpp b/examples/quick_and_dirty/quick_and_dirty.cpp
@@ -24,7 +24,7 @@ class example_system final : public antara::gaming::ecs::post_update_system<exam
     example_system(entt::registry& entity_registry, entt::dispatcher& dispatcher) noexcept : system(entity_registry,
                                                                                                   dispatcher)
     {
-        //! Here you can initialize your systems, adding entities etc
+        //! Here you can initialize your system, adding entities etc
     }
 
     void update() noexcept final
@@ -47,7 +47,7 @@ REFL_AUTO(type(example_system));
 class my_world_example : public antara::gaming::world::app
 {
 public:
-    my_world_example()
+    my_world_example() noexcept
     {
         this->system_manager_.create_system<example_system>(); //! Here we load our system to use it.
     }