Update README.md (#15)

* Update README.md

* Update README.md
This commit is contained in:
Lars Melchior
2019-04-15 14:06:21 +02:00
committed by GitHub
parent 946019a336
commit 3e65078ce7

View File

@@ -20,7 +20,8 @@ CPMAddPackage(
NAME LarsParser NAME LarsParser
GIT_REPOSITORY https://github.com/TheLartians/Parser.git GIT_REPOSITORY https://github.com/TheLartians/Parser.git
VERSION 1.8 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" "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 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 # Advantages
- **Auto handle dependencies** Users of your projects do not need to worry about dependencies, everything is handled automatically. - **Small repos** CPM takes care of package dependencies, allowing programmers to focus on creating small well-tested frameworks.
- **Reproducable builds** Using git tags it is ensured that a project will always be in the same state everywhere. - **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. - **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 # Limitations