feat(docs): docs more accurate

KomodoPlatform · Oct 3, 2019 · 2610ff0 · 2610ff0
1 parent 39c713d
commit 2610ff0
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 57 deletions.
diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
@@ -78,6 +78,7 @@ add_custom_command(OUTPUT ${SPHINX_INDEX_FILE}
         ${CMAKE_CURRENT_SOURCE_DIR}/source/tutorials/tutorials.rst
         ${CMAKE_CURRENT_SOURCE_DIR}/source/tutorials/ecs.rst
         ${CMAKE_CURRENT_SOURCE_DIR}/source/tutorials/getting_started.rst
+        ${CMAKE_CURRENT_SOURCE_DIR}/source/tutorials/basic_setup.rst
         ${CMAKE_CURRENT_SOURCE_DIR}/source/tutorials/quick_and_dirty.rst
         ${DOXYGEN_INDEX_FILE}
         MAIN_DEPENDENCY ${SPHINX_SOURCE}/conf.py

diff --git a/docs/source/helpers/alternative_README.rst b/docs/source/helpers/alternative_README.rst
@@ -1,7 +1,6 @@
 .. role:: raw-html-m2r(raw)
    :format: html
 
-
 antara-gaming-sdk
 =================
 

diff --git a/docs/source/tutorials/basic_setup.rst b/docs/source/tutorials/basic_setup.rst
@@ -0,0 +1,54 @@
+Setup
+^^^^^
+
+In this tutorial I will assume that you want to write a system for a project outside the gaming SDK. (An External Game Project)
+
+Firstly we will need a **CMakeLists.txt**:
+
+.. code-block:: cmake
+
+    if (${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR})
+        message(FATAL_ERROR "Prevented in-tree build. Please create a build directory outside of the source code and call cmake from there")
+    endif ()
+
+    cmake_minimum_required(VERSION 3.14)
+
+    set(CMAKE_CXX_STANDARD 17)
+
+    project(my_game_project DESCRIPTION "my_game_description" LANGUAGES CXX)
+
+    if (NOT "${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
+        message(FATAL_ERROR "Only Clang is supported (minimum LLVM 8.0)")
+    endif ()
+
+    if (${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
+        set(LINUX TRUE)
+    endif ()
+
+    include(FetchContent)
+
+    FetchContent_Declare(
+            antara-gaming-sdk
+            URL https://github.com/KomodoPlatform/antara-gaming-sdk/archive/master.zip
+    )
+
+    FetchContent_MakeAvailable(antara-gaming-sdk)
+    init_apple_env()
+
+    add_executable(${PROJECT_NAME} my_example_system.cpp)
+    target_link_libraries(${PROJECT_NAME} PUBLIC antara::world)
+
+
+As the ``CMakeLists.txt`` suggests we also need a **C++** files named ``my_example_system.cpp`` with the following contents:
+
+.. literalinclude:: ../../../examples/common/step_basis_world_compiling.cpp
+   :language: cpp
+
+And now we can successfully build the setup project that we just made:
+
+.. raw:: html
+
+    <embed>
+        <script id="asciicast-RuOAzT29eEl51cOrsnX1yEFyo" src="https://asciinema.org/a/RuOAzT29eEl51cOrsnX1yEFyo.js" async data-speed="3" data-size="small"></script>
+    </embed>
+
diff --git a/docs/source/tutorials/ecs.rst b/docs/source/tutorials/ecs.rst
@@ -1,60 +1,9 @@
-Tutorial: antara gaming systems
+Tutorial: Antara Gaming Systems
 ===============================
 
+If you have not read the :doc:`getting started<getting_started>` part yet, I invite you to do it now for the rest of this tutorial.
+
 How to create your own system step by step ?
 --------------------------------------------
 
-Setup
-^^^^^
-
-In this tutorial I will assume that you want to write a system for a project outside the gaming SDK. (An External Game Project)
-
-Firstly we will need a **CMakeLists.txt**:
-
-.. code-block:: cmake
-
-    if (${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR})
-        message(FATAL_ERROR "Prevented in-tree build. Please create a build directory outside of the source code and call cmake from there")
-    endif ()
-
-    cmake_minimum_required(VERSION 3.14)
-
-    set(CMAKE_CXX_STANDARD 17)
-
-    project(my_game_project DESCRIPTION "my_game_description" LANGUAGES CXX)
-
-    if (NOT "${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
-        message(FATAL_ERROR "Only Clang is supported (minimum LLVM 8.0)")
-    endif ()
-
-    if (${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
-        set(LINUX TRUE)
-    endif ()
-
-    include(FetchContent)
-
-    FetchContent_Declare(
-            antara-gaming-sdk
-            URL https://github.com/KomodoPlatform/antara-gaming-sdk/archive/master.zip
-    )
-
-    FetchContent_MakeAvailable(antara-gaming-sdk)
-    init_apple_env()
-
-    add_executable(${PROJECT_NAME} my_example_system.cpp)
-    target_link_libraries(${PROJECT_NAME} PUBLIC antara::world)
-
-
-As the ``CMakeLists.txt`` suggests we also need a **C++** files named ``my_example_system.cpp`` with the following contents:
-
-.. literalinclude:: ../../../examples/common/step_basis_world_compiling.cpp
-   :language: cpp
-
-And now we can successfully build the setup project that we just made:
-
-.. raw:: html
-
-    <embed>
-        <script id="asciicast-RuOAzT29eEl51cOrsnX1yEFyo" src="https://asciinema.org/a/RuOAzT29eEl51cOrsnX1yEFyo.js" async data-speed="3" data-size="small"></script>
-    </embed>
-
+.. include:: basic_setup.rst
diff --git a/docs/source/tutorials/quick_and_dirty.rst b/docs/source/tutorials/quick_and_dirty.rst
@@ -1,7 +1,7 @@
 Tutorial: Quick And Dirty
 ============================================
 
-If you have not done the :doc:`getting started<getting_started>` part yet, I invite you to do it now for the rest of this tutorial.
+If you have not read the :doc:`getting started<getting_started>` part yet, I invite you to do it now for the rest of this tutorial.
 
 prerequisites
 -----------------------