Browse Source

Add documentation for init-script usage to README.md file

Patrick-Christopher Mattulat 1 year ago
parent
commit
e2c46d25c0
1 changed files with 9 additions and 3 deletions
  1. 9 3
      README.md

+ 9 - 3
README.md

@@ -1,6 +1,6 @@
 # Lynar Studios - Standard Library 2023.3.0 #
 # Lynar Studios - Standard Library 2023.3.0 #
 
 
-This is a cross-platform standard library written in C++ offering functionalities you would usually miss in C++'s standard template library (STL), especially if you would search for cross-platform implementations.  
+This is a cross-platform standard library written in C++ offering functionalities you would usually miss in C++'s standard library, especially if you would search for cross-platform implementations.  
 This library has been tested on __Windows__, __Linux__ and __MacOS__ systems.
 This library has been tested on __Windows__, __Linux__ and __MacOS__ systems.
 Following a modularized approach the following independent submodules are defined in scope of this library:
 Following a modularized approach the following independent submodules are defined in scope of this library:
  
  
@@ -34,11 +34,11 @@ A __Date__ class comes with this submodule, which you can use to represent a dat
 
 
 #### Features ####
 #### Features ####
 
 
-- Section Pair values now support backslash characters, which are common on Windows to describe a file path
+---
 
 
 #### Improvements ####
 #### Improvements ####
 
 
-- solved more than 400 SonarLint findings, which were mostly on critical level
+- an OS-specific initialization-script is now being provided for setting up the project and preparing it for the developer for code-contribution
 
 
 #### Fixes ####
 #### Fixes ####
 
 
@@ -142,6 +142,12 @@ target_link_libraries(... ls-std-core ls-std-boxing ...)
 
 
 ---
 ---
 
 
+### Project Contribution ###
+
+#### Initialization ####
+
+To initialize this project and prepare it for local development, an OS-specific init-script must be executed. This script is located in __config/scripts__ location of the projects' root folder. Choose the OS-specific script (e.g. init.sh for Linux) and execute it via CLI.
+
 ### Run Automated Tests ###
 ### Run Automated Tests ###
 
 
 When enabling test build CMake flag during CMake project generation, executable test suite binaries will be generated during project compilation.  
 When enabling test build CMake flag during CMake project generation, executable test suite binaries will be generated during project compilation.