diff --git a/README.md b/README.md index 47d17c5..888176f 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,8 @@ CPMAddPackage( NAME LarsParser GIT_REPOSITORY https://github.com/TheLartians/Parser.git VERSION 1.8 - OPTIONS + GIT_TAG v1.8 # optional, as already defined by VERSION + OPTIONS # used to set CMake options in the inner package "LARS_PARSER_BUILD_GLUE_EXTENSION ON" ) @@ -38,12 +39,20 @@ To add CPM to your current project, simply include add `cmake/CPM.cmake` to your wget -O cmake/CPM.cmake https://raw.githubusercontent.com/TheLartians/CPM/master/cmake/CPM.cmake ``` +# Supported packages + +Basically any project that you can add via `add_subdirectory` should work with CPM. + +# Options + +If you set the CMake option `CPM_REMOTE_PACKAGES_ONLY` to `On`, packages will always be fetched via the URL. Setting `CPM_LOCAL_PACKAGES_ONLY` to `On` will only add packages via `find_package`. + # Advantages -- **Auto handle dependencies** Users of your projects do not need to worry about dependencies, everything is handled automatically. -- **Reproducable builds** Using git tags it is ensured that a project will always be in the same state everywhere. +- **Small repos** CPM takes care of package dependencies, allowing programmers to focus on creating small well-tested frameworks. +- **Cross-Plattform** CPM adds projects via `add_subdirectory`, which is compatible with all cmake toolchains and generators. +- **Reproducable builds** By using versioning via git tags it is ensured that a project will always be in the same state everywhere. - **No installation required** No need to install any third-party package managers. Just copy the files from the CMake directory and you're good to go. -- **Cross-Plattform** As CPM adds projects as cmake subdirectories, it is compatible with all cmake toolchains and generators. # Limitations