A C++ Project Template
This is a simple project template, which main language is C++. Its main purpose is to demonstrate clean code and clean architecture.
This project serves as a template so it will probably be missing the software requirements you need for your particular experiment/project.
However, the sample code provided contains a list of software that is required to either build, test or lint the project. Unlike other README files, I decided to keep this information on a script file that will detect and prompt to install said requirements, which I think it is a much better approach to documenting system or software requirements. Please refer to those documents.
Run the configure.bat file.
Run the configure.sh file.
This project is configured to install the "final" product on specific paths (which you can change). For more information, read the INSTALL files in the docs\ folder.
You can contribute to this repository (the C++ Template Project) by following these steps:
- Create a new issue on this repository's GitHub page ()
- Create a branch from the new issue page, and in doing so, create a new branch. Please, make sure to branch from
dev. Themainandrelease-*branches will be protected and contain special workflows. - Make your contribution. If it is code, please, make sure it runs all tests (at least on your environment, e.g. Ubuntu 22.04 LTS).
This project is provided with a MIT License. For more information read this.
The following URLs were used to create this README: