Skip to content

A basic C++ Project template file structure created to help me with sideprojects. it allows the easy creation of libraries, profiling information, tests, and more.

License

Notifications You must be signed in to change notification settings

BenrickSmit/GeneralCXXTemplate

Repository files navigation

GeneralCXXTemplate

A basic C++ Project template file structure created to help me with sideprojects. It allows the easy creation of libraries, profiling information, tests, and more.

Description

This is a general C++ template project structure. It comes with automated documentation, automated testing (using gtest), automated profiling (using gprof) and CMake to help with the execution.

init_documentation.sh is used to create the documentation automatically run_all.sh is used to run all tests and program execution, as well as to create the necessary documentation and profile information run_application.sh is used to run only the application run_tests.sh is used to run only the tests run_profile.sh is used to run only the profiler

build_info contains the build_name, build_version, and build_cxx_standard text files. build_name contains the project name. build_version contains the project version number. build_cxx_standard contains the CXX standard used, it's default is 11

Find the project here, if you did not find this project on my github.

Features

This states the current features provided by the program

Future Changes

This gives information on the future changes that are likely to be implemented.

How to Run

This gives information on how to normally run the python program

How to Run Unit Tests

This gives information on how to normally run the python program's tests

Key Dependencies

This gives information on the dependencies required by the python program

How to contribute

This states how others can contribute to the project, and what styles to use

License

This states the licence

About

A basic C++ Project template file structure created to help me with sideprojects. it allows the easy creation of libraries, profiling information, tests, and more.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published