Fix CI pipelines (#3)

* Fix trigger branch name for integration

* Will ubuntu runner work with current conf?

* Remove shell reference

* Trying to fix integration

* Update Main.cpp

* C++17

Author: nerudaj

.github/workflows/CI.yml

@@ -12,7 +12,10 @@ env:
 
 jobs:
   build:
-    runs-on: windows-2022
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, windows-2022 ]
+    runs-on: ${{ matrix.os }}
 
     steps:
     - uses: actions/checkout@v4
@@ -25,15 +28,12 @@ jobs:
         mkdir "${{ env.BUILD_DIR }}"
         cd "${{ env.BUILD_DIR }}"
         cmake ..
-      shell: cmd
 
     - name: Build
       working-directory: ${{ env.BUILD_DIR }}
       run: |
         cmake --build . --config Release
-      shell: cmd
 
     - name: Test
       working-directory: ${{ env.BUILD_DIR }}
       run: ctest -C Release
-      shell: cmd

.github/workflows/Integration.yml

@@ -2,9 +2,9 @@ name: IntegrationTests
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [ "master" ]
   pull_request:
-    branches: [ "main" ]
+    branches: [ "master" ]
   workflow_dispatch:
 
 env:

README.md

@@ -4,6 +4,10 @@ Simple and Fast header only Bitmap (BMP) library
 ## Bitmap Type Supported
 - 24 Bits Per Pixel (RGB)
 
+## Integration
+
+You can either download the header file and use it your project directly, or you can leverage CMake for this. The library can be easily integrated with FetchContent or through CPM. An example of CPM integration can be found [here](integration_tests/cpm).
+
 ## Examples
 <strong>Random Pixel Colors</strong>
 <br>

examples/CMakeLists.txt

@@ -7,7 +7,7 @@ foreach(example_file ${EXAMPLES_FILES})
     get_filename_component(target_name ${example_file} NAME_WE)
 
     add_executable(${target_name} ${example_file})
-    target_link_libraries( ${target_name} bpp::BitmapPlusPlus )
+    target_link_libraries( ${target_name} bmp::BitmapPlusPlus )
     target_compile_definitions ( ${target_name} PRIVATE "ROOT_DIR=\"${PROJECT_SOURCE_DIR}\"" )
     target_compile_definitions ( ${target_name} PRIVATE "BIN_DIR=\"${PROJECT_BINARY_DIR}\"" )
 

integration_tests/cpm/CMakeLists.txt

@@ -8,8 +8,10 @@ CPMAddPackage ( "gh:nerudaj/BitmapPlusPlus#${GIT_BRANCH}" )
 
 project ( demo )
 
+set(CMAKE_CXX_STANDARD 17) # C++17 or newer is required
+
 add_executable( ${PROJECT_NAME}
-    "${CMAKE_CURRENT_SOURCE_DIR}/../../examples/draw_primitives.cpp"
+    "${CMAKE_CURRENT_SOURCE_DIR}/Main.cpp"
 )
 
-target_link_libraries( ${PROJECT_NAME} LINK_PRIVATE bpp::BitmapPlusPlus )
+target_link_libraries( ${PROJECT_NAME} LINK_PRIVATE bmp::BitmapPlusPlus )

integration_tests/cpm/Main.cpp

@@ -0,0 +1,12 @@
+#include <BitmapPlusPlus.hpp>
+
+int main()
+{
+    bmp::Bitmap bitmap(512, 512);
+    for (auto& pixel : bitmap)
+    {
+        pixel = bmp::Pixel(42, 69, 96);
+    }
+
+    bitmap.save("demo.bmp");
+}

integration_tests/cpm/Readme.md

@@ -14,7 +14,7 @@ And link it to your target using:
 target_link_libraries( ${TARGET} LINK_PRIVATE bpp::BitmapPlusPlus )
 ```
 
-After that, you can simply include the library in your code:
+Note that your target needs to compile with C++17 or newer. After that, you can simply include the library in your code:
 
 ```cpp
 #include <BitmapPlusPlus.hpp>

lib/CMakeLists.txt

@@ -3,4 +3,4 @@ cmake_minimum_required ( VERSION 3.10 )
 add_library ( BitmapPlusPlus INTERFACE )
 target_include_directories( BitmapPlusPlus INTERFACE "${CMAKE_CURRENT_SOURCE_DIR}/include" )
 
-add_library ( bpp::BitmapPlusPlus ALIAS BitmapPlusPlus )
+add_library ( bmp::BitmapPlusPlus ALIAS BitmapPlusPlus )