Merge pull request #196 from cpp-best-practices/enable_examples

Enable examples

Author: lefticus

.github/workflows/ci.yml

@@ -29,8 +29,7 @@ jobs:
       matrix:
         os:
           - ubuntu-20.04
-          - macos-10.15
-          - windows-2019
+          - macos-11
         compiler:
           # you can specify the version after `-` like "llvm-13.0.0".
           - llvm
@@ -46,25 +45,12 @@ jobs:
 
         exclude:
           # mingw is determined by this author to be too buggy to support
-          - os: windows-2019
+          - os: macos-11
             compiler: gcc
-
-        include:
-          # Add appropriate variables for gcov version required. This will intentionally break
-          # if you try to use a compiler that does not have gcov set
-          - compiler: gcc
-            gcov_executable: gcov
-          - compiler: llvm
-            gcov_executable: "llvm-cov gcov"
-
-          # This exists solely to make sure a non-multiconfig build works
           - os: ubuntu-20.04
-            compiler: gcc
-            generator: "Unix Makefiles"
-            build_type: Debug
-            gcov_executable: gcov
-            developer_mode: On
+            compiler: llvm
 
+        include:
           - os: windows-2022
             compiler: msvc
             generator: "Visual Studio 17 2022"
@@ -79,12 +65,12 @@ jobs:
             compiler: msvc
             generator: "Visual Studio 17 2022"
             build_type: Debug
-            developer_mode: Off
+            developer_mode: OFF
           - os: windows-2022
             compiler: msvc
             generator: "Visual Studio 17 2022"
             build_type: Release
-            developer_mode: Off
+            developer_mode: OFF
 
 
 
@@ -127,11 +113,16 @@ jobs:
           gcovr: true
           opencppcoverage: true
 
+      - name: Install Linux Packages Needed By SDL
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get -y install libx11-dev libx11-xcb-dev libfontenc-dev libice-dev libsm-dev libxau-dev libxaw7-dev libxcomposite-dev libxcursor-dev libxdamage-dev libxdmcp-dev libxext-dev libxfixes-dev libxft-dev libxi-dev libxinerama-dev libxkbfile-dev libxmu-dev libxmuu-dev libxpm-dev libxrandr-dev libxrender-dev libxres-dev libxss-dev libxt-dev libxtst-dev libxv-dev libxvmc-dev libxxf86vm-dev xtrans-dev libxcb-render0-dev libxcb-render-util0-dev libxcb-xkb-dev libxcb-icccm4-dev libxcb-image0-dev libxcb-keysyms1-dev libxcb-randr0-dev libxcb-shape0-dev libxcb-sync-dev libxcb-xfixes0-dev libxcb-xinerama0-dev xkb-data libxcb-dri3-dev libxcb-util-dev libegl-dev
+
         # make sure coverage is only enabled for Debug builds, since it sets -O0 to make sure coverage
         # has meaningful results
       - name: Configure CMake
         run: |
-          cmake -S . -B ./build -G "${{matrix.generator}}" -DCMAKE_BUILD_TYPE:STRING=${{matrix.build_type}} -DENABLE_DEVELOPER_MODE:BOOL=${{matrix.developer_mode}} -DOPT_ENABLE_COVERAGE:BOOL=${{ matrix.build_type == 'Debug' }}
+          cmake -S . -B ./build -G "${{matrix.generator}}" -DCMAKE_BUILD_TYPE:STRING=${{matrix.build_type}} -DENABLE_DEVELOPER_MODE:BOOL=${{matrix.developer_mode}} -DOPT_ENABLE_COVERAGE:BOOL=${{ matrix.build_type == 'Debug' && matrix.developer_mode == 'OFF' }}
 
       - name: Build
         # Execute the build.  You can specify a specific target with "--target <NAME>"

CMakeLists.txt

@@ -1,18 +1,24 @@
 cmake_minimum_required(VERSION 3.16)
 
-# uncomment to set a default CXX standard for the external tools like clang-tidy and cppcheck
-# and the targets that do not specify a standard.
-# If not set, the latest supported standard for your compiler is used
-# You can later set fine-grained standards for each target using `target_compile_features`
-# Note: linking together projects compiled with different C++ standards may work, but
-# it is not recommended because of possible issues with ABI
+# Not ideal to use this global variable, but necessary to make sure
+# that tooling and projects use the same version
 set(CMAKE_CXX_STANDARD 20)
 
 # strongly encouraged to enable this globally to avoid conflicts between
 # -Wpedantic being enabled and -std=c++20 and -std=gnu++20 for example
 # when compiling with PCH enabled
 set(CMAKE_CXX_EXTENSIONS OFF)
 
+
+# Note: by default ENABLE_DEVELOPER_MODE is True
+# This means that all analysis (sanitizers, static analysis)
+# is enabled and all warnings are treated as errors
+# if you want to switch this behavior, change TRUE to FALSE
+set(ENABLE_DEVELOPER_MODE TRUE CACHE BOOL "Enable 'developer mode'")
+
+# Change this to false if you want to disable warnings_as_errors in developer mode
+set(OPT_WARNINGS_AS_ERRORS_DEVELOPER_DEFAULT TRUE)
+
 # Add project_options v0.15.1
 # https://github.com/cpp-best-practices/project_options
 include(FetchContent)
@@ -26,7 +32,12 @@ include(${_project_options_SOURCE_DIR}/Index.cmake)
 # run_vcpkg()
 
 # Set the project name and language
-project(myproject LANGUAGES CXX C)
+project(
+  myproject
+  VERSION 0.0.1
+  DESCRIPTION "Starter Project With Best Practices for C++"
+  HOMEPAGE_URL "https://github.com/cpp-best-practices/cpp_boilerplate_project"
+  LANGUAGES CXX C)
 
 get_property(BUILDING_MULTI_CONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
 if(BUILDING_MULTI_CONFIG)
@@ -79,6 +90,11 @@ dynamic_project_options(
 
 target_compile_features(project_options INTERFACE cxx_std_${CMAKE_CXX_STANDARD})
 
+# configure files based on CMake configuration options
+add_subdirectory(configured_files)
+target_include_directories(project_options INTERFACE "${CMAKE_BINARY_DIR}")
+
+
 # Adding the src:
 add_subdirectory(src)