Project Template

this repo contains the boilerplate for my future projects so I don't have to create a project from scratch

Project Structure

• include is for containing header files
• docs contains generated documentation by doxide and mkdocs
• libs is for containing external libraries' source code which builds with the main project
• src is containing the main program's source code
• tests is for containing unit tests to test various parts of the software

Toolset

• CMake for build system generator
• Doxide for generating documentation
• Googletest for testing and mocking
• Docker & github actions for CI/CD
• AStyle to automatically format code

Setting up the project

External Dependencies(if you're new to C++)

• CMake
• GNU make or Ninja
• GCC or Clang or MSVC(windows only)
• AStyle(optional)
• Doxide and mkdocs + mkdocs-material(optional)

Setup

clone the repo with submodules

git clone --recurse-submodules https://github.com/Rellotscrewdriver/my-project-template.git mpt

goto the cloned repo and configure the project

cd mpt
cmake -S . -B build

build the project

cmake --build build

then run the program

Generating the documentation

run the gendocs.sh script to avoid typing commands manually everytime after running go to your browser and type localhost:8000 to see the generated documentation.

if you're using windows you can rename the gendocs.sh file to gendocs.bat. Ditto fmtallfiles.sh

Adding Internal Libraries

This project template currently uses git submodules to manage internal libraries in the libs folder. to add the library into this project(not in this template)

git submodule add <github_link> libs/<library>

add the cloned directory to CMakeLists.txt

add_subdirectory(libs/<library>)

link the library to the main project

target_link_libraries(${PROJECT_NAME} PRIVATE <library_linkers>)

NOTE: the linker name will be different for each library you trying to add so make sure to read their documentation on how to link their libraries through CMake

Contributions

We explicitly welcome outside contributors. you can read our CODE_OF_CONDUCT for rules
and CONTRIBUTING for contribution guidelines and coding style

Screenshots

People usually like to see how it looks before downloading the product.

COPYRIGHT

this project is free to use and distribute as long as you don't claim that you wrote the original software. crediting of this project is required when it is modified and/or distributed. goto LICENSE for more details