CharlesAverill / C_Project

Friendly Template for C Projects

C_Project

A template for C Projects using either [CMake, Autotools] and Doxygen for building and documentation generation, respectively.

Features

• Includes automatically look inside of the include directory
• By including info.h, variables defined in CMakeLists.txt or include/autotools_info.h.in are exposed to the program, such as the project's name and version information
• Argument parsing
• Scripts to format, compile, and run the program, script to build documentation with Doxygen
  • Doxygen formatting can be modified in Doxyfile
  • Project code formatting can be modified in .clang-format
• Github Action to auto-generate documentation with Doxygen and publish to Github Pages
  • A gh-pages branch must exist for this Action to function without error
  • View docs here
• compile.sh will compile the project
• run.sh will compile and run the project

Requirements

• For CMake
  • cmake==3.13.0^
• doxygen==1.9.1^
• clang-format==14.0.0^
• A C compiler

Setup

To configure the directory for either CMake or Autotools, run setup.sh [either "cmake" or "autotools" here]. After this, it should be possible to run the program with just run.sh

Notes

This template repository is licensed with the Unlicense, so derived repositories from this template are free to be relicensed as their owners see fit.