nopsteam/c-cmake-sdl2-boilerplate

C, Cmake and SDL2 Boilerplate

C, Cmake and SDL2 Boilerplate

This is a C project template with the following features:

• CMake build scripts for building libraries, applications, and tests.
• Integrated with SDL2.
• Integrated with SDL2 Image.
• Integrated with Unity unit test framework.
• Integrated with FetchContent for library dependencies like Unity.
• Resource folder to include assets
• Updated and improved version of C-project-template

Usage

Setup

This will build cmake files and download dependencies

make setup

Build

# Debug build
make debug
# Release build
make release

Run Tests

This will build and run unity tests

make test

Code Coverage Checks

This will build and run unity tests and generate reports for coverage (depends on lcov)

make coverage
# This part is optional: Generates a html with more coverage details
genhtml build/coverage/coverage.info --output-directory build/coverage/out

Clean

This will delete generated files for debug and release

make clean

Run Binary

This will open an SDL black window with the unlicense logo on it for 3 seconds.

# Debug bin
./build/debug/bin/example_app
# Release bin
./build/release/bin/example_app

Directory Structure

./
├── .github
│   └── workflows -- Github workflows folder.
├── app -- Application source code
├── build
│   ├── cmake -- Cmake Finders for external compiled libs.
│   ├── debug -- Cmake debug build generated files.
│   │   ├── bin -- Application debug binaries.
│   │   └── resources -- Application resources assets symbolic link.
│   └── release -- Cmake release build generated files.
│       ├── bin -- Application release binaries.
│       └── resources -- Application resources assets symbolic link.
├── resources -- Application resources assets folder.
├── src -- Library source code and headers.
└── test -- Test source code.
    └── unity -- Unity test framework source.

Dependencies

• Clang
• Make
• CMake
• SDL2
• SDL2 Image
• LCOV

Installing Dependencies

Arch Linux

yay -Sy clang cmake lcov sdl2 sdl2_image

Ubuntu

sudo add-apt-repository -y "deb http://archive.ubuntu.com/ubuntu `lsb_release -sc` main universe restricted multiverse"
sudo apt-get update -y -qq
sudo apt-get install clang cmake lcov libsdl2-dev libsdl2-image-dev

Showcase

Projects using this boilerplate:

• 6502 Emulator

License

This is free and unencumbered software released into the public domain.
For more information, please refer to http://unlicense.org/