Merge pull request #980 from PowerGridModel/feature/update-build-guide

meet-up hackaton: update build guide

Author: TonyXiang8787

CMakeLists.txt

@@ -11,7 +11,7 @@ include("cmake/pgm_version.cmake")
 
 project (power_grid_model VERSION ${PGM_VERSION})
 
-option(PGM_ENABLE_TESTS "Enable tests" OFF)
+option(PGM_ENABLE_DEV_BUILD "Enable developer build (e.g.: tests)" OFF)
 
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)

docs/advanced_documentation/build-guide.md

@@ -175,7 +175,7 @@ You can use any IDE to develop this project. As a popular cross-platform IDE, th
 
 ```{note}
 VSCode (as well as some other IDEs) does not set its own build environment itself. For optimal usage, open the folder
-using `cmake <project_dir>` from a terminal that has the environment set up. See above section for tips.
+using `code <project_dir>` from a terminal that has the environment set up. See above section for tips.
 ```
 
 ## Build Script for Linux/macOS
@@ -194,9 +194,9 @@ Usage: ./build.sh -p <preset> [-c] [-e] [-i] [-t]
 
 To list the available presets, run `./build.sh -h`.
 
-## Example Setup for Ubuntu 22.04 (in WSL or physical/virtual machine)
+## Example Setup for Ubuntu 24.04 (in WSL or physical/virtual machine)
 
-In this section an example is given for setup in Ubuntu 22.04. You can use this example in Windows Subsystem for Linux (
+In this section an example is given for setup in Ubuntu 24.04. You can use this example in Windows Subsystem for Linux (
 WSL), or in a physical/virtual machine.
 
 ### Environment variables
@@ -286,7 +286,7 @@ or install using
 cmake --build --preset <preset> --target install
 ```
 
-## Example Setup for Windows 10
+## Example Setup for Windows 11
 
 Define the following environment variable user-wide:
 
@@ -374,9 +374,9 @@ The IDE should be able to automatically detect the Visual Studio cmake configura
   Prompt`).
 ```
 
-## Example Setup for macOS (Big Sur)
+## Example Setup for macOS (Sequoia)
 
-In this section an example is given for setup in macOS Big Sur and Python 3.11.
+In this section an example is given for setup in macOS Sequoia and Python 3.11.
 
 ### Environment variables
 
@@ -427,7 +427,7 @@ As an example, go to the root folder of repo. Use the following command to build
 ./build.sh -p <preset>
 ```
 
-To list the available presets, run `./build.sh -h`.
+To list the available presets, run `cmake --list-presets`.
 
 One can run the unit tests and C API example by: