Browse Source

Add guidelines reference to README.md file

Patrick-Christopher Mattulat 2 months ago
parent
commit
906bef9764
1 changed files with 4 additions and 0 deletions
  1. 4 0
      README.md

+ 4 - 0
README.md

@@ -156,6 +156,10 @@ target_link_libraries(... ls-std-core ls-std-boxing ...)
 
 
 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.
 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.
 
 
+#### Guidelines ####
+
+Please refer to the __coding-guidelines.md__ file located in __doc/internal__ to be able to follow the library style.
+
 ### 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.