Rename first example

CMakeLists.txt

@@ -13,6 +13,8 @@ set(CMAKE_CXX_EXTENSIONS OFF)
 # Global Project Settings
 ################################
 
+# module names
+
 set(MODULE_NAME_CYCLE ls-atlantis-cycle)
 set(MODULE_NAME_FACTORY ls-atlantis-factory)
 set(MODULE_NAME_INPUT ls-atlantis-input)
@@ -20,6 +22,12 @@ set(MODULE_NAME_INTERFACE ls-atlantis-interface)
 set(MODULE_NAME_MESSAGING ls-atlantis-messaging)
 set(MODULE_NAME_WINDOW ls-atlantis-window)
 
+# example names
+
+set(EXAMPLE_NAME_BASIC_SDL_WINDOW ls-atlantis-basic-sdl-window)
+
+# settings
+
 set(CMAKE_DEBUG_POSTFIX -d)
 
 include_directories(${CMAKE_CURRENT_LIST_DIR}/include)

README.md

@@ -45,8 +45,16 @@ In Process: It contains the following modules:
 
 The following table illustrates a list of required dependencies
 
-| Name   | Version     | Explanation                                                |
+| Name   | Version     | Description                                                |
 |--------|-------------|------------------------------------------------------------|
 | gtest  | 1.17.0      | The Google Test framework for unit- and integration tests. |
 | ls-std | v2024.1.0.1 | The Lynar Studios C++-Standard library.                    |
 | sdl    | 3.4.8       | The Window API library SDL3.                               |
+
+## Examples
+
+This project comes with examples demonstrating the engine's capabilities.
+
+| Example Name     | Description                                                                                   |
+|------------------|-----------------------------------------------------------------------------------------------|
+| Basic SDL Window | This example opens a SDL window, which can be closed via pressing escape key on the keyboard. |

cmake/ls-atlantis-example.cmake

@@ -4,19 +4,19 @@
 ################################################################
 ################################################################
 
-add_executable(ls-atlantis-example
+add_executable(${EXAMPLE_NAME_BASIC_SDL_WINDOW}
         ${CMAKE_CURRENT_SOURCE_DIR}/output/BasicSdlWindowExample.cpp
 )
 
-target_link_libraries(ls-atlantis-example PRIVATE
+target_link_libraries(${EXAMPLE_NAME_BASIC_SDL_WINDOW} PRIVATE
     ${MODULE_NAME_CYCLE}
 )
 
 if (WIN32)
-    add_custom_command(TARGET ls-atlantis-example POST_BUILD
-        COMMAND ${CMAKE_COMMAND} -E copy -t $<TARGET_FILE_DIR:ls-atlantis-example>
-            $<TARGET_RUNTIME_DLLS:ls-atlantis-example>
-        COMMAND ${CMAKE_COMMAND} -E copy -t $<TARGET_FILE_DIR:ls-atlantis-example>
+    add_custom_command(TARGET ${EXAMPLE_NAME_BASIC_SDL_WINDOW} POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy -t $<TARGET_FILE_DIR:${EXAMPLE_NAME_BASIC_SDL_WINDOW}>
+            $<TARGET_RUNTIME_DLLS:${EXAMPLE_NAME_BASIC_SDL_WINDOW}>
+        COMMAND ${CMAKE_COMMAND} -E copy -t $<TARGET_FILE_DIR:${EXAMPLE_NAME_BASIC_SDL_WINDOW}>
             "$<$<CONFIG:Debug>:${LS_STD_DLLS_DEBUG}>"
             "$<$<CONFIG:Release>:${LS_STD_DLLS_RELEASE}>"
         COMMAND_EXPAND_LISTS