mirror of
https://github.com/cpm-cmake/CPM.cmake.git
synced 2026-02-06 23:07:22 +08:00
Update README.md (#17)
This commit is contained in:
17
README.md
17
README.md
@@ -2,7 +2,11 @@
|
|||||||
|
|
||||||
# CPM
|
# CPM
|
||||||
|
|
||||||
CPM is a minimalistic package manager written in Cmake using `find_package` and `FetchContent` as a fallback to download non locally installed packages.
|
CPM is a minimalistic package manager written in CMake. It downloads and adds packages via `FetchContent` or uses locally installed packages if applicable via `find_package`.
|
||||||
|
|
||||||
|
# Supported packages
|
||||||
|
|
||||||
|
Any project that you can add via `add_subdirectory` should already work with CPM.
|
||||||
|
|
||||||
# Usage
|
# Usage
|
||||||
|
|
||||||
@@ -11,6 +15,7 @@ To add a new dependency to your project simply add the Projects target name, the
|
|||||||
```cmake
|
```cmake
|
||||||
cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
|
cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
|
||||||
|
|
||||||
|
# create project
|
||||||
project(MyProject)
|
project(MyProject)
|
||||||
|
|
||||||
# add dependencies
|
# add dependencies
|
||||||
@@ -18,11 +23,9 @@ include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/CPM.cmake)
|
|||||||
|
|
||||||
CPMAddPackage(
|
CPMAddPackage(
|
||||||
NAME LarsParser
|
NAME LarsParser
|
||||||
|
VERSION 1.8 # optional, will try find_package(LarsParser 1.8) before downloading
|
||||||
GIT_REPOSITORY https://github.com/TheLartians/Parser.git
|
GIT_REPOSITORY https://github.com/TheLartians/Parser.git
|
||||||
VERSION 1.8
|
GIT_TAG v1.8 # optional, as indirectly defined by VERSION
|
||||||
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"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
# add executable
|
# add executable
|
||||||
@@ -39,10 +42,6 @@ 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
|
# 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`.
|
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`.
|
||||||
|
|||||||
Reference in New Issue
Block a user