Skip to content

c-template

https://github.com/standardloop/c-template

GitHub Release C Version

About

Template repo to spawn C projects from.

Running

This repo uses task.

Please run task list to see all the avaiable tasks.

Available Tasks

task: Available tasks for this project:
* list                  Lists all the tasks available to run.
* default               Builds and runs the test program.
* dependencies          Downloads C program dependencies.
* release               Release the dylib, used by GitHub actions.
* test:build            Builds the test program.
* test:run              Runs the test program.
* test:build-sanitize   Builds the test program with address sanitizers.
* test:run-sanitize     Runs the test program with address sanitizers.
* clean                 Cleans binary files.
* fmt                   Formats the C code with the `.clang-format` file.
* docs                  Generate docs/index.md and the task list in README.md
* test:leaks            Run macOS leaks on the test program.

Dependencies

Using mise

$ mise install
$ eval "$(mise activate bash)"
# when done
$ mise deactivate
$ mise prune
$ mise cache clean

Using brew and npm

$ brew install \
    prek \
    go-task \
    doxygen

$ npm install moxygen -g

Releasing

Releases are handled via GitHub Actions.

Docs

Docs are generated a first generated with doxygen as xml and then moxygen reads the xml to output markdown in the docs/ folder.

This repo uses reusable tasks from https://github.com/standardloop/taskfiles/

Precommit

This repo uses prek.

Please run prek install.