commit 386db851

Poul Sander · 2019-03-07 19:36
386db851ccd52b4be991b159621e749e33eeae96 patch · browse files
parent 0267c8388fda8eabaf252a45b008d154ee75bef7
parent 5b48757364ae75d879de7808256b40af5ab103d9

Merge pull request #18 from sum01/cmake_alias

Cmake alias

Changed files

M	CMakeLists.txt before
M	README.md before

diff --git a/CMakeLists.txt b/CMakeLists.txt index d82991e..61dcfed 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt

@@ -9,6 +9,10 @@ add_library(platform_folders

sago/platform_folders.cpp

)

+# Creates an alias so that people building in-tree (instead of using find_package)...

+# can still link against the same target

+add_library(sago::platform_folders ALIAS platform_folders)

# Defines standardized defaults for install paths

include(GNUInstallDirs)

# Where to search for the header while building

diff --git a/README.md b/README.md index 4978a0f..8488b9a 100644 --- a/README.md +++ b/README.md

@@ -45,9 +45,9 @@ This project should be compatible with things like [Cmake's ExternalProject_Add]

You can also follow the [build step](#building) below to install at a system level, and use [Cmake's find_package](https://cmake.org/cmake/help/latest/command/find_package.html).

```cmake

-# Specifying a version is optional -- note it follows by Semver

+# Specifying a version is optional -- note it follows Semver

find_package(platform_folders 3.1.0 REQUIRED)

-# Which creates the IMPORTED lib "sago::platform_folders"

+# Which imports the linkable library "sago::platform_folders"

# Use it like so...

target_link_libraries(EXEORLIBNAME PRIVATE sago::platform_folders)

```

@@ -55,6 +55,8 @@ target_link_libraries(EXEORLIBNAME PRIVATE sago::platform_folders)

Alternatively, you can just copy the [sago](https://github.com/sago007/PlatformFolders/tree/master/sago) folder into your program and manually link everything.

If you use the last option and are using a library version from before 4.0.0: Remember to link to the CoreServices lib when compiling on Mac. This typically means passing "-framework CoreServices" during the linking phase.

+Note that if you build in-tree, you can link against the Cmake alias `sago::platform_folders` just like if you had used find_package.

### Building

**Notes:**