Merge pull request #651 from aregtech/feature/619-move-docs-to-wiki

Update and improve wiki docs, add conditional log

Author: aregtech

CMakeLists.txt

@@ -1,5 +1,5 @@
 # ###########################################################################
-#               CMake options of AREG SDK
+#               CMake options of Areg SDK
 # Copyright 2022-2026 Aregtech
 # ###########################################################################
 
@@ -17,7 +17,7 @@ include(${AREG_CMAKE_CONFIG_DIR}/setup.cmake)
 # set CMake tool settings
 set(CMAKE_BUILD_TYPE        ${AREG_BUILD_TYPE} CACHE STRING "Configuration Type" FORCE)
 
-# AREG SDK project name and version
+# Areg SDK project name and version
 set(AREG_PROJECT_NAME "areg-sdk")
 set(AREG_PROJECT_VERSION "1.9.99.111")
 
@@ -26,7 +26,7 @@ set(PROJECT_NAME ${AREG_PROJECT_NAME})
 set(PROJECT_VERSION ${AREG_PROJECT_VERSION})
 project("${PROJECT_NAME}" 
         VERSION      "${PROJECT_VERSION}" 
-        DESCRIPTION  "AREG Communication Framework and Tools" 
+        DESCRIPTION  "Areg Communication Framework and Tools" 
         HOMEPAGE_URL "https://areg.tech" 
         LANGUAGES    CXX C)
 
@@ -46,22 +46,22 @@ add_custom_command( TARGET areg-dummy PRE_BUILD
 include_directories(${AREG_FRAMEWORK})
 include_directories(${AREG_THIRDPARTY})
 
-# build AREG Framework thirdparty software
+# build Areg Framework thirdparty software
 include(${AREG_THIRDPARTY}/CMakeLists.txt)
 if (NOT AREG_SQLITE_FOUND)
     add_dependencies(aregsqlite3 areg-dummy)
 endif()
 
-# build AREG Framework software
+# build Areg Framework software
 include(${AREG_FRAMEWORK}/CMakeLists.txt)
 add_dependencies(areg areg-dummy)
 
-# build optional AREG project examples, if required
+# build optional Areg project examples, if required
 if(AREG_BUILD_EXAMPLES)
     include(${AREG_EXAMPLES}/CMakeLists.txt)
 endif()
 
-# build optional AREG Framework unit tests, if required
+# build optional Areg Framework unit tests, if required
 if(AREG_BUILD_TESTS)
     include(${AREG_TESTS}/CMakeLists.txt)
     if (NOT AREG_GTEST_FOUND)
@@ -83,6 +83,6 @@ endif()
 printAregConfigStatus(
     TRUE
     "AREG"
-    "----------------------> AREG project CMake Status Report Begin <-----------------------"
-    "-----------------------> AREG project CMake Status Report End <------------------------"
+    "----------------------> Areg project CMake Status Report Begin <-----------------------"
+    "-----------------------> Areg project CMake Status Report End <------------------------"
 )

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# CONTRIBUTING TO AREG SDK
+# CONTRIBUTING TO Areg SDK
 
 Thank you for your interest in contributing to Areg SDK.  
 We welcome developers, companies, researchers, and hobbyists who want to help improve the framework.

README.md

@@ -1,7 +1,7 @@
 # Release Notes
 
 ```
-This document contains the release notes of AREG SDK project.
+This document contains the release notes of Areg SDK project.
 Copyright © Aregtech UG, 2021-2026
 Contact: info[at]areg.tech
 ```
@@ -15,7 +15,7 @@ Release date: 15.06.2023
 - Compilation with CYGWIN
 - Compilation with VSCode
 - Service Watchdog
-- AREG extended objects (Console)
+- Areg extended objects (Console)
 - GTest integration for unit tests
 - More examples
 
@@ -30,8 +30,8 @@ Release date: 15.06.2023
    * Software build
    * Preprocessor define symbols
    * Compile with WSL
-   * AREG Logging System
-   * AREG Multitarget Router
+   * Areg Logging System
+   * Areg Multitarget Router
    * Persistence Syntax
 
 ### Deprecated
@@ -44,7 +44,7 @@ Release date: 15.06.2023
 Release date: 11.11.2021
 
 ### New Features
-- AREG interface-centric framework
+- Areg interface-centric framework
 - Build with MSVC
 - Build with Makefile
 - Build with Eclipse

Releases.md

@@ -732,11 +732,12 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "wiki", "wiki", "{C33D0DF1-A
 		docs\wiki\01b-cmake-build.md = docs\wiki\01b-cmake-build.md
 		docs\wiki\01c-msvc-build.md = docs\wiki\01c-msvc-build.md
 		docs\wiki\01d-wsl-build.md = docs\wiki\01d-wsl-build.md
-		docs\wiki\02a-cmake-config.md = docs\wiki\02a-cmake-config.md
-		docs\wiki\02b-cmake-functions.md = docs\wiki\02b-cmake-functions.md
-		docs\wiki\02c-cmake-integrate.md = docs\wiki\02c-cmake-integrate.md
-		docs\wiki\02d-msvc-integrate.md = docs\wiki\02d-msvc-integrate.md
-		docs\wiki\02e-preprocessor-definitions.md = docs\wiki\02e-preprocessor-definitions.md
+		docs\wiki\02a-quick-project-setup.md = docs\wiki\02a-quick-project-setup.md
+		docs\wiki\02b-cmake-integrate.md = docs\wiki\02b-cmake-integrate.md
+		docs\wiki\02c-msvc-integrate.md = docs\wiki\02c-msvc-integrate.md
+		docs\wiki\02d-cmake-config.md = docs\wiki\02d-cmake-config.md
+		docs\wiki\02e-cmake-functions.md = docs\wiki\02e-cmake-functions.md
+		docs\wiki\02f-preprocessor-definitions.md = docs\wiki\02f-preprocessor-definitions.md
 		docs\wiki\03a-mtrouter.md = docs\wiki\03a-mtrouter.md
 		docs\wiki\04a-logging-config.md = docs\wiki\04a-logging-config.md
 		docs\wiki\04b-logging-develop.md = docs\wiki\04b-logging-develop.md
@@ -749,8 +750,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "wiki", "wiki", "{C33D0DF1-A
 		docs\wiki\06d-setup-lusan.md = docs\wiki\06d-setup-lusan.md
 		docs\wiki\06e-lusan-service-interface.md = docs\wiki\06e-lusan-service-interface.md
 		docs\wiki\06f-lusan-live-logging.md = docs\wiki\06f-lusan-live-logging.md
-		docs\wiki\07a-troubleshooting-wsl-update.md = docs\wiki\07a-troubleshooting-wsl-update.md
 		docs\wiki\06g-lusan-offline-logging.md = docs\wiki\06g-lusan-offline-logging.md
+		docs\wiki\07a-troubleshooting-wsl-update.md = docs\wiki\07a-troubleshooting-wsl-update.md
 		docs\wiki\07b-troubleshooting-cmake-linux-builds.md = docs\wiki\07b-troubleshooting-cmake-linux-builds.md
 		docs\wiki\07c-troubleshooting-integration.md = docs\wiki\07c-troubleshooting-integration.md
 		docs\wiki\08a-examples-and-tests.md = docs\wiki\08a-examples-and-tests.md

areg-sdk.sln

@@ -1,5 +1,5 @@
 # ###########################################################################
-# Settings for external projects to integrate AREG framework
+# Settings for external projects to integrate Areg framework
 # Copyright (c) 2022-2026 Aregtech
 # ###########################################################################
 
@@ -10,31 +10,31 @@
 # Define AREG_SDK_ROOT before including this file in the project.
 if (NOT DEFINED AREG_SDK_ROOT OR "${AREG_SDK_ROOT}" STREQUAL "")
     # Make sure that AREG_SDK_ROOT is set before the 'setup.cmake' is included
-    message(FATAL_ERROR "AREG: >>> Set \'AREG_SDK_ROOT\' before including \'setup.cmake\'. Stopping building the project.")
+    message(FATAL_ERROR "Areg: >>> Set \'AREG_SDK_ROOT\' before including \'setup.cmake\'. Stopping building the project.")
     return()
 else()
-    message(STATUS "AREG: >>> Specified AREG_SDK_ROOT = \'${AREG_SDK_ROOT}\'")
+    message(STATUS "Areg: >>> Specified AREG_SDK_ROOT = \'${AREG_SDK_ROOT}\'")
 endif()
 
 # The location of cmake configuration files.
 if (NOT DEFINED AREG_CMAKE_CONFIG_DIR OR "${AREG_CMAKE_CONFIG_DIR}" STREQUAL "")
     set(AREG_CMAKE_CONFIG_DIR   "${AREG_SDK_ROOT}/conf/cmake")
 else()
-    message(STATUS "AREG: >>> Specified AREG_CMAKE_CONFIG_DIR = \'${AREG_CMAKE_CONFIG_DIR}\'")
+    message(STATUS "Areg: >>> Specified AREG_CMAKE_CONFIG_DIR = \'${AREG_CMAKE_CONFIG_DIR}\'")
 endif()
 
 # Disable or enable areg-sdk specific outputs
 if (NOT DEFINED AREG_ENABLE_OUTPUTS OR "${AREG_ENABLE_OUTPUTS}" STREQUAL "")
-    option(AREG_ENABLE_OUTPUTS "Disable AREG SDK specific outputs, use defaults" OFF)
-    message(STATUS "AREG: >>> Disable AREG SDK specific outputs, use defaults")
+    option(AREG_ENABLE_OUTPUTS "Disable Areg SDK specific outputs, use defaults" OFF)
+    message(STATUS "Areg: >>> Disable Areg SDK specific outputs, use defaults")
 endif()
 
 # Include setup.cmake to initialize variables
-message(STATUS "AREG: >>> Including \'${AREG_CMAKE_CONFIG_DIR}/setup.cmake\'")
+message(STATUS "Areg: >>> Including \'${AREG_CMAKE_CONFIG_DIR}/setup.cmake\'")
 include("${AREG_CMAKE_CONFIG_DIR}/setup.cmake")
 
 # Include common.cmake to initialize compile options
-message(STATUS "AREG: >>> Including \'${AREG_CMAKE_CONFIG_DIR}/common.cmake\'")
+message(STATUS "Areg: >>> Including \'${AREG_CMAKE_CONFIG_DIR}/common.cmake\'")
 include("${AREG_CMAKE_CONFIG_DIR}/common.cmake")
 
 set(AREG_RESOURCES "${AREG_FRAMEWORK}/areg/resources")

areg.cmake

@@ -3,7 +3,7 @@
 # Copyright 2022-2026 Aregtech
 # ###########################################################################
 
-message(STATUS "AREG: >>> Preparing settings for CLang compiler under \'${AREG_OS}\' platform, WIN32 = \'${WIN32}\'")
+message(STATUS "Areg: >>> Preparing settings for CLang compiler under \'${AREG_OS}\' platform, WIN32 = \'${WIN32}\'")
 
 if (AREG_OS STREQUAL "Windows")
 

conf/cmake/clang.cmake

@@ -19,18 +19,18 @@ if ("${AREG_COMPILER_FAMILY}" STREQUAL "")
 
     macro_setup_compilers_data("${CMAKE_CXX_COMPILER}" AREG_COMPILER_FAMILY AREG_COMPILER_SHORT AREG_CXX_COMPILER AREG_C_COMPILER AREG_TARGET AREG_PROCESSOR AREG_BITNESS _compiler_found)
     if (_compiler_found)
-        message(STATUS "AREG: >>> Use system default settings:")
-        message(STATUS "AREG: ... Compiler family = '${AREG_COMPILER_FAMILY}'")
-        message(STATUS "AREG: ... CXX compiler = '${AREG_CXX_COMPILER}'")
-        message(STATUS "AREG: ... CC  compiler = '${AREG_C_COMPILER}'")
-        message(STATUS "AREG: ... Compiler Target = '${AREG_TARGET}'")
+        message(STATUS "Areg: >>> Use system default settings:")
+        message(STATUS "Areg: ... Compiler family = '${AREG_COMPILER_FAMILY}'")
+        message(STATUS "Areg: ... CXX compiler = '${AREG_CXX_COMPILER}'")
+        message(STATUS "Areg: ... CC  compiler = '${AREG_C_COMPILER}'")
+        message(STATUS "Areg: ... Compiler Target = '${AREG_TARGET}'")
     else()
-        message(WARNING "AREG: >>> The compiler \'${${CMAKE_CXX_COMPILER}}\' is unknown, the compilation result is unpredictable")
+        message(WARNING "Areg: >>> The compiler \'${${CMAKE_CXX_COMPILER}}\' is unknown, the compilation result is unpredictable")
     endif()
 
 elseif("${AREG_COMPILER_SHORT}" STREQUAL "")
 
-    message(FATAL_ERROR "AREG: >>> The file \'${AREG_CMAKE_CONFIG_DIR}/setup.cmake\' should be included before \'common.cmake\', fix it and retry again.")
+    message(FATAL_ERROR "Areg: >>> The file \'${AREG_CMAKE_CONFIG_DIR}/setup.cmake\' should be included before \'common.cmake\', fix it and retry again.")
 
 endif()
 
@@ -125,7 +125,7 @@ elseif (MSVC)
 
 else()
 
-    message(WARNING "AREG: >>> Unsupported compiler type may cause unpredicted results, use default GNU compiler settings and POSIX API")
+    message(WARNING "Areg: >>> Unsupported compiler type may cause unpredicted results, use default GNU compiler settings and POSIX API")
     include(${AREG_CMAKE_CONFIG_DIR}/gnu.cmake)
 
 endif()
@@ -138,8 +138,8 @@ if (AREG_EXTENDED)
             list(APPEND AREG_EXTENDED_LIBS ncurses)
             set(AREG_EXTENDED_LIBS_STR "-lncurses")
         else()
-            message(STATUS "AREG: >>> No suitable 'ncurses' library found for '${AREG_PROCESSOR}' processor, force to disable extended objects.")
-            set(AREG_EXTENDED OFF CACHE INTERNAL "Disable AREG Extended objects")
+            message(STATUS "Areg: >>> No suitable 'ncurses' library found for '${AREG_PROCESSOR}' processor, force to disable extended objects.")
+            set(AREG_EXTENDED OFF CACHE INTERNAL "Disable Areg Extended objects")
             add_definitions(-DAREG_EXTENDED=0)
         endif()
     else()