shrukan/cpp-template
Template
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases 2 Wiki Activity
Files
c44db2b219840fc5d386125fe7d4c42474e878bb
cpp-template/README.md
shrukan 73ab18abdb Add build instructions to readme
2022-12-26 18:24:00 -08:00

1.1 KiB
Raw Blame History

${REPO_NAME_PASCAL}

CI

${REPO_DESCRIPTION}

Build Instructions

The provided Docker image includes all necessary dependencies to build and debug C/C++ applications. While the main build system is Meson, a Makefile is provided for convenience. With dependencies installed, or inside the Docker container, run the following:

  • make to build the application
  • make test to run all configured tests
  • make coverage to run tests and generate coverage reports
  • make debug to compile with debug flags
  • make release to compile with release optimization (default)
  • make sanitize to compile with address sanitizer
  • make scan-build to run LLVM scan-build, if installed (not by default in the docker image)
  • make docs/html to build the HTML Doxygen documentation
  • make clang-format to run the autoformatter
  • make clean to delete artifacts from the build directory
  • make spotless to delete the build directory altogether and purge subprojects

All other targets are passed directly to the Ninja backend.