commit ed93318e

Poul Sander · 2018-06-24 11:20
ed93318e6b01b6bc0e9edc7fa97b354e508336fc patch · browse files
parent 51c6406523d03e35eae96a8930db2954114c3c05

Update README.md

Added notes about Mac OS X and the drop of the Core Framework. The information is still included but will be removed after 4.0.0 has been released.

Changed files

M	README.md before

diff --git a/README.md b/README.md index 4e9d207..4978a0f 100644 --- a/README.md +++ b/README.md

@@ -34,7 +34,9 @@ It should work on any Unix system that has the following headers available: `pwd

### macOS

-Uses the deprecated FSFindFolder (there is no C++ alternative), which requires the CoreServices framework during linking.

+Version 4.0.0 and forward uses hardcoded values for the directories on Mac OS X. Unlike the other operating systems the folders cannot be moved on a Mac and the translation is done in the UI.

+The versions 2.X and 3.X uses the deprecated FSFindFolder, which requires the CoreServices framework during linking.

+Version 1.X simple used the XDG specification.

## Usage

@@ -51,13 +53,13 @@ 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: Remember to link to the CoreServices lib when compiling on Mac. This typically means passing "-framework CoreServices" during the linking phase.

+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.

### Building

**Notes:**

-* macOS requires the CoreServices framework during linking.

+* Until 4.0.0 macOS required the CoreServices framework during linking.

* If you don't want to install, remove the `--target install` command.

Linux/macOS: