https://github.com/jdumas/cpp-project-template
Template repository for C++ projects using CMake, libigl, etc.
https://github.com/jdumas/cpp-project-template
cmake cpp graphics
Last synced: 11 months ago
JSON representation
Template repository for C++ projects using CMake, libigl, etc.
- Host: GitHub
- URL: https://github.com/jdumas/cpp-project-template
- Owner: jdumas
- License: mit
- Created: 2019-11-23T21:48:53.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-11-24T21:24:38.000Z (over 6 years ago)
- Last Synced: 2025-04-03T02:02:26.733Z (about 1 year ago)
- Topics: cmake, cpp, graphics
- Language: CMake
- Size: 56.6 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# C++ Project Template
[](https://travis-ci.com/jdumas/cpp-project-template)
[](https://dev.azure.com/jdumas-github/cpp-project-template/_build/latest?definitionId=1&branchName=master)
Template repository for C++ projects using CMake, libigl, etc.
### Getting Started
Create a new github repository using this project [as template](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template):
Then replace all placeholders with your new project name using this simple python script:
```
./misc/bootstrap.py
```
### Project Structure
The main file you want to be looking at to add/update dependencies is `cmake/@Project_Name@External.cmake`. Do not look at `@Project_Name@Boilerplate.cmake`, this is the file doing the dirty laundry so that `@Project_Name@External.cmake` looks pretty. Everything else should speak for itself, mostly.
We use CMake's [FetchContent](https://cmake.org/cmake/help/latest/module/FetchContent.html) mechanism to download external dependencies at CMake time so that they can be built alongside your main project. External dependencies are compiled statically so the produced executable is as self-contained as possible.
The goal of this project is to provide a modern template for C++ project using CMake. Thus, you will need at least:
- CMake 3.11
- C++17
The core mechanism used to import an external dependencies (download + create a CMake target) is the `@project_name@_import()` function. For example, to create a new executable that depends on libigl, CLI11 and tinyfiledialogs, you can use the following:
```cmake
add_executable(MyViewer
main.cpp
filedialogs.cpp
filedialogs.h
viewer.cpp
viewer.h
)
@project_name@_import(libigl cli11 tinyfiledialogs)
target_link_libraries(MyViewer
PRIVATE
igl::opengl_glfw_imgui
CLI11::CLI11
tinyfiledialogs::tinyfiledialogs
)
# Use C++17
target_compile_features(MyViewer PUBLIC cxx_std_17)
```
where `@project_name@` should be replaced by your project name when you run the `./misc/bootstrap.py` script. Note that the name given to the `@project_name@_import()` function is different from the target name (`Foo::Bar`) available once the library is imported. The table below lists all libraries which are available for import in this current template. One important detail to note is that *nothing is downloaded* if you do not import a library. Thus, adding libraries to this template will not "bloat" your starting project unless you decide to actually use it. The reasoning is that it should be easier to remove imported libraries from this template than to add a new one should you need it.
### Available Libraries
| FetchContent name | Target name | Url |
| --- | --- | --- |
| `catch2` | `Catch2::Catch2` | [Catch2](https://github.com/catchorg/Catch2.git) |
| `cli11` | `CLI11::CLI11` | [CLI11](https://github.com/CLIUtils/CLI11.git) |
| `cppoptlib` | `cppoptlib::cppoptlib` | [CppNumericalSolvers](https://github.com/PatWie/CppNumericalSolvers.git) |
| `eigen` | `Eigen3::Eigen` | [Eigen](https://github.com/eigenteam/eigen-git-mirror) |
| `ghc_filesystem` | `ghc::filesystem` | [Filesystem](https://github.com/gulrak/filesystem.git) |
| `fmt` | `fmt::fmt` | [{fmt}](https://github.com/fmtlib/fmt) |
| `json` | `nlohmann_json::nlohmann_json` | [JSON](https://github.com/nlohmann/json) |
| `libigl` | `igl::core`, ... | [libigl](https://github.com/libigl/libigl.git) |
| `nanoflann` | `nanoflann::nanoflann` | [nanoflann](https://github.com/jlblancoc/nanoflann) |
| `pcg` | `pcg::pcg` | [PCG](https://github.com/imneme/pcg-cpp.git) |
| `simple_svg` | `simple_svg::simple_svg` | [simple-svg](https://github.com/adishavit/simple-svg.git) |
| `spdlog` | `spdlog::spdlog` | [spdlog](https://github.com/gabime/spdlog) |
| `tbb` | `tbb::tbb` | [Threading Building Blocks](https://github.com/wjakob/tbb.git) |
| `tinyfiledialogs` | `tinyfiledialogs::tinyfiledialogs` | [tiny file dialogs](https://sourceforge.net/projects/tinyfiledialogs/) |
| `windingnumber` | `windingnumber::windingnumber` | [WindingNumber](https://github.com/sideeffects/WindingNumber) |
### Continuous Integration
It is a good idea to ensure that your code always builds, and does so on all platforms (Windows, Linux, macOS). You do not want to push code that might leave your coworkers unhappy because they cannot build the project anymore. To that end, we use continuous integration via the following services:
- [Travis CI](https://docs.travis-ci.com/user/tutorial/)
- [Azure Pipeline](https://docs.microsoft.com/en-us/azure/devops/pipelines/repos/github)
Both support Windows, Linux and macOS. Feel free to adapt existing scripts to your needs. Travis can be used for private projects if you have an education account.
### Notes
##### Libigl
By default, we use libigl in header-only mode, single building in static mode takes a long time. However, as your project grows, you might want to switch the CMake option `LIBIGL_USE_STATIC_LIBRARY` to `ON` to accelerate incremental builds (this is especially useful in combination with a caching compiler such as `ccache`).
##### Filesystem
With C++17, in theory the `` header from the Standard Template Library provides a cross-platform filesystem library. Unfortunately, compiler support is still lacking, in particular on macOS -- you need at least Xcode 11 and macOS 10.15, which may not be supported by our CI platforms yet. To that end, we define an alias target `std::filesystem`. This target will add the necessary linking flags if `` or `` are supported on your system. If not, it will download [ghc::filesystem](https://github.com/gulrak/filesystem) and use that as an alias. Automatic namespace forwarding is implemented in [filesystem.h](https://github.com/jdumas/cpp-project-template/blob/master/src/@project_name@/filesystem.h) so you can use it directly.
##### Logger
*TODO*
##### Clang-format
*TODO*
##### Sanitizers
*TODO*
### Useful links
- [An Introduction to Modern CMake](https://cliutils.gitlab.io/modern-cmake/)