Add library type in contribution guide

Signed-off-by: Uilian Ries <[email protected]>
cieslarmichal · Jun 28, 2024 · a7d82d8 · a7d82d8
1 parent 073e161
commit a7d82d8
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 22 deletions.
diff --git a/.github/workflows/linux-clang-build.yml b/.github/workflows/linux-clang-build.yml
@@ -79,8 +79,7 @@ jobs:
             -DUSE_SYSTEM_DEPENDENCIES:BOOL=ON \
             -DUSE_STD_FORMAT:BOOL=ON \
             -DCMAKE_TOOLCHAIN_FILE=build/Debug/generators/conan_toolchain.cmake \
-            -DCMAKE_EXE_LINKER_FLAGS=-fuse-ld=lld \
-            -DCMAKE_INSTALL_PREFIX=${{ github.workspace }}/install
+            -DCMAKE_EXE_LINKER_FLAGS=-fuse-ld=lld
 
       - name: Build
         run: cmake --build --preset=unixlike-clang-debug-${{ matrix.type }}
@@ -89,7 +88,7 @@ jobs:
         run: ctest --preset=unixlike-clang-debug-${{ matrix.type }}
 
       - name: Install
-        run: cmake --build --preset=unixlike-gcc-debug-${{ matrix.type }} --target install
+        run: cmake --build --preset=unixlike-clang-debug-${{ matrix.type }} --target install
 
       - name: Examples
         run: |

diff --git a/.github/workflows/linux-gxx-build.yml b/.github/workflows/linux-gxx-build.yml
@@ -77,8 +77,7 @@ jobs:
             -DUSE_STD_FORMAT:BOOL=ON \
             -DUSE_SYSTEM_DEPENDENCIES:BOOL=ON \
             -DCMAKE_TOOLCHAIN_FILE=build/Debug/generators/conan_toolchain.cmake \
-            -DCMAKE_EXE_LINKER_FLAGS=-fuse-ld=gold \
-            -DCMAKE_INSTALL_PREFIX=${{ github.workspace }}/install
+            -DCMAKE_EXE_LINKER_FLAGS=-fuse-ld=gold
 
       - name: Build
         run: cmake --build --preset=unixlike-gcc-debug-${{ matrix.type }}

diff --git a/.github/workflows/macos-clang-build.yml b/.github/workflows/macos-clang-build.yml
@@ -84,8 +84,7 @@ jobs:
             -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
             -DUSE_STD_FORMAT:BOOL=ON \
             -DUSE_SYSTEM_DEPENDENCIES:BOOL=ON \
-            -DCMAKE_TOOLCHAIN_FILE=build/Debug/generators/conan_toolchain.cmake \
-            -DCMAKE_INSTALL_PREFIX=${{ github.workspace }}/install
+            -DCMAKE_TOOLCHAIN_FILE=build/Debug/generators/conan_toolchain.cmake
 
       - name: Build
         run: cmake --build --preset=unixlike-clang-debug-static
@@ -94,4 +93,4 @@ jobs:
         run: ctest --preset=unixlike-clang-debug-static
 
       - name: Install
-        run: cmake --build --preset=unixlike-gcc-debug-static --target install
+        run: cmake --build --preset=unixlike-clang-debug-static --target install
diff --git a/.github/workflows/windows-msvc-build.yml b/.github/workflows/windows-msvc-build.yml
@@ -64,7 +64,7 @@ jobs:
 
       - name: Configure CMake
         run: |
-          cmake -S . --preset=windows-msvc-debug-${{ matrix.type }} -G Ninja -DCMAKE_TOOLCHAIN_FILE=${{ github.workspace }}\build\Debug\generators\conan_toolchain.cmake -DCMAKE_INSTALL_PREFIX=${{ github.workspace }}\install -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER=cl.exe -DBUILD_TESTING:BOOL=ON -DUSE_STD_FORMAT:BOOL=ON -DUSE_SYSTEM_DEPENDENCIES:BOOL=ON
+          cmake -S . --preset=windows-msvc-debug-${{ matrix.type }} -G Ninja -DCMAKE_TOOLCHAIN_FILE=${{ github.workspace }}\build\Debug\generators\conan_toolchain.cmake -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER=cl.exe -DBUILD_TESTING:BOOL=ON -DUSE_STD_FORMAT:BOOL=ON -DUSE_SYSTEM_DEPENDENCIES:BOOL=ON
 
       - name: Build
         run: cmake --build --preset=windows-msvc-debug-${{ matrix.type }}

diff --git a/CMakePresets.json b/CMakePresets.json
@@ -12,6 +12,7 @@
             "hidden": true,
             "binaryDir": "${sourceDir}/build/${presetName}",
             "installDir": "${sourceDir}/install/${presetName}",
+            "generator": "Ninja",
             "cacheVariables": {
                 "USE_SYSTEM_DEPENDENCIES": "FALSE",
                 "USE_STD_FORMAT": "TRUE",

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -107,31 +107,37 @@ Follow the steps below to build the project:
 
     ```sh
     cmake --list-presets
-    "unixlike-gcc-debug"     - gcc Debug
-    "unixlike-gcc-release"   - gcc Release
-    "unixlike-clang-debug"   - clang Debug
-    "unixlike-clang-release" - clang Release
-    "windows-msvc-release"   - msvc Release
-    "windows-msvc-release"   - msvc Debug
+    "unixlike-gcc-debug-static"     - Unixlike GCC Debug Static library
+    "unixlike-gcc-debug-shared"     - Unixlike GCC Debug Shared library
+    "unixlike-gcc-release-static"   - Unixlike GCC Release Static library
+    "unixlike-gcc-release-shared"   - Unixlike GCC Release Shared library
+    "unixlike-clang-debug-static"   - Unixlike Clang Debug Static library
+    "unixlike-clang-debug-shared"   - Unixlike Clang Debug Shared library
+    "unixlike-clang-release-static" - Unixlike Clang Release Static library
+    "unixlike-clang-release-shared" - Unixlike Clang Release Shared library
+    "windows-msvc-debug-static"     - Windows MSVC Debug Static library
+    "windows-msvc-debug-shared"     - Windows MSVC Debug Shared library
+    "windows-msvc-release-static"   - Windows MSVC Release Static library
+    "windows-msvc-release-shared"   - Windows MSVC Release Shared library
     ```
 
-   For instance, if you are in Ubuntu and want to build using GCC in Debug mode, you should use the
-   preset `unixlike-gcc-debug`. The `unixlike-clang-` preset should work for both Linux and macOS when using the CLang
+   For instance, if you are in Ubuntu and want to build using GCC in Debug mode and static library (faker-cxx.a), you should use the
+   preset `unixlike-gcc-debug=static`. The `unixlike-clang-` preset should work for both Linux and macOS when using the CLang
    compiler.
 
    The `-S .` option in the following command specifies the source directory:
 
     ```sh
-    cmake -S . --preset unixlike-gcc-debug
+    cmake -S . --preset unixlike-gcc-debug-static
     ```
 
 3. **Build the project:**
 
    The following command generates the build files and compiles the project using the settings specified in
-   the `unixlike-gcc-debug` preset:
+   the `unixlike-gcc-debug-static` preset:
 
     ```sh
-    cmake --build --preset unixlike-gcc-debug
+    cmake --build --preset unixlike-gcc-debug-static
     ```
 
 ### Testing the Project
@@ -142,9 +148,29 @@ tests. Follow the steps below to test the project:
 **1. Run the tests using the same preset:**
 
     ```sh
-    ctest --preset unixlike-gcc-debug
+    ctest --preset unixlike-gcc-debug-static
     ```
 
+### Installing the Project
+
+When wanting to install those generated artifacts like headers files and library, you can use CMake to operate as installer as well:
+
+   ```sh
+      cmake --build --preset unixlike-gcc-debug-static --target install
+   ```
+
+By default, CMake will install in the subfolder `install` in the source folder.
+
+In order to change the installation folder, you can use [CMAKE_INSTALL_PREFIX](https://cmake.org/cmake/help/latest/variable/CMAKE_INSTALL_PREFIX.html) to configure the destination folder:
+
+   ```sh
+      cmake -S . --preset unixlike-gcc-debug-static -DCMAKE_INSTALL_PREFIX=/opt/faker-cxx
+      cmake --build --preset unixlike-gcc-debug-static --target install
+   ```
+
+This configuration will install all artifacts in `/opt/faker-cxx`. The permission to write in the folder should be granted before executing the installation command.
+
+
 ## Submitting Changes
 
 Once you've made your changes and ensured they adhere to the project's coding style and pass all tests, you can submit
@@ -186,7 +212,7 @@ PR titles are written in following convention: `type: subject`
 
 **type** is required and indicates the intent of the PR
 
-> The types `feat` and `fix` will be shown in the changelog as `### Features` or `### Bug Fixes`  
+> The types `feat` and `fix` will be shown in the changelog as `### Features` or `### Bug Fixes`
 
 Allowed types are: