Skip to content
/ c-cpp-template Public template

Template repository for C/C++ project including Makefile and CMake support, functional workflows for CI and Doxygen docs deployment to GitHub Pages and CodeQL code scan.

License

Notifications You must be signed in to change notification settings

milosz275/c-cpp-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

68 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

C/C++ Project Template

Make CodeQL CMake on multiple platforms Doxygen Pages License

Logo

This is a template for C/C++ projects. It includes a Makefile for building either C or C++, a directory structure for organizing the source code, and a README.md file for documenting the project.

Table of Contents

Getting Started

To use this template click "Use this template" and create a new repository or open the template in a codespaces or use this template here.

use template screen

After the repository is recreated, please modify repo settings in order to GitHub Pages docs deploy workflow succeed. Select GitHub Actions as a source for build and deployment.

Important

Even if your repository is private, deployed docs will be available publicly.

github pages

CodeQL might not work for private repositories. If you want to use it, you need to enable it in the repository settings, else remove the workflow.

Build

Repository comes ready with out-of-the-box options for Makefile as well as CMake. Feel free to remove one that you won't need.

Adjustments

Adding new directories

Edit main Makefile for build-ignored directories. Each other new directory is required to have Makefile. CMake is building project-name directory at this moment.

Choosing C/C++

You cannot use both C and C++ at the same time using this template. Choose proper file format in the project Makefile and adjust input files in the Doxyfile.

Doxygen Docs

Adjust Doxygen Documentation page icon in header.html file in line 16.

adjust ico file

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Template repository for C/C++ project including Makefile and CMake support, functional workflows for CI and Doxygen docs deployment to GitHub Pages and CodeQL code scan.

Topics

Resources

License

Stars

Watchers

Forks