schtobia/ModernCppStarter
1
0
Fork 0
mirror of https://github.com/TheLartians/ModernCppStarter.git synced 2025-10-31 02:01:33 +01:00
Code Issues Activity

remove CPMFindPackage from the readme

Browse source
This commit is contained in:
Lars Melchior 2021-03-26 17:00:17 +01:00
parent eb6ed2cafe
commit 3c04b03c5d
1 changed files with 6 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -171,19 +171,17 @@ Instead, create a new directory or project with a CMakeLists that adds the libra
Depending type it might make sense move these components into a separate repositories and reference a specific commit or version of the library. Depending type it might make sense move these components into a separate repositories and reference a specific commit or version of the library.
This has the advantage that individual libraries and components can be improved and updated independently. This has the advantage that individual libraries and components can be improved and updated independently.
> You recommend to add external dependencies using CPM.cmake. Will this force users of my library to use CPM as well? > You recommend to add external dependencies using CPM.cmake. Will this force users of my library to use CPM.cmake as well?
[CPM.cmake](https://github.com/TheLartians/CPM.cmake) should be invisible to library users as it's a self-contained CMake Script. [CPM.cmake](https://github.com/TheLartians/CPM.cmake) should be invisible to library users as it's a self-contained CMake Script.
If problems do arise, users can always opt-out by defining `CPM_USE_LOCAL_PACKAGES`, which will override all calls to `CPMAddPackage` with `find_package`. If problems do arise, users can always opt-out by defining the CMake or env variable [`CPM_USE_LOCAL_PACKAGES`](https://github.com/cpm-cmake/CPM.cmake#options), which will override all calls to `CPMAddPackage` with the according `find_package` call.
Alternatively, you could use `CPMFindPackage` instead of `CPMAddPackage`, which will try to use `find_package` before calling `CPMAddPackage` as a fallback. This should also enable users to use the project with their favorite external C++ dependency manager, such as vcpkg or Conan.
Both approaches should be compatible with common C++ package managers without modifications, however come with the cost of reproducible builds.
> Can I configure and build my project offline? > Can I configure and build my project offline?
Using CPM, all missing dependencies are downloaded at configure time. No internet connection is required for building the project, however when using CPM missing dependencies are downloaded at configure time.
To avoid redundant downloads, it's recommended to set a CPM cache directory, e.g.: `export CPM_SOURCE_CACHE=$HOME/.cache/CPM`. To avoid redundant downloads, it's highly recommended to set a CPM.cmake cache directory, e.g.: `export CPM_SOURCE_CACHE=$HOME/.cache/CPM`.
This will also allow offline configurations if all dependencies are present. This will enable shallow clones and allow offline configurations dependencies are already available in the cache.
No internet connection is required for building.
> Can I use CPack to create a package installer for my project? > Can I use CPack to create a package installer for my project?