summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJason Wray <jason@mapbox.com>2016-09-30 16:33:41 -0400
committerJason Wray <friedbunny@users.noreply.github.com>2016-09-30 18:49:05 -0400
commitd3b308a695a746e781cdc3929868e5793899ea05 (patch)
tree9ce200ebe483b4324ea64e3551774f661b857c23
parentd7a44a6b902f2bf90766f7c470cf759187193480 (diff)
downloadqtlocation-mapboxgl-d3b308a695a746e781cdc3929868e5793899ea05.tar.gz
[macos] Add 'Packaging builds' section to developing doc
-rw-r--r--platform/macos/DEVELOPING.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/platform/macos/DEVELOPING.md b/platform/macos/DEVELOPING.md
index 412a58a140..cf52a650aa 100644
--- a/platform/macos/DEVELOPING.md
+++ b/platform/macos/DEVELOPING.md
@@ -14,6 +14,32 @@ The Mapbox macOS SDK requires Xcode 7.3 or above.
1. Run `make xproj`.
1. Switch to the “dynamic” or “macosapp” scheme. The former builds just the Cocoa framework, while the latter also builds a Cocoa demo application based on it.
+### Packaging builds
+
+Install [jazzy](https://github.com/realm/jazzy) for generating API documentation:
+
+```bash
+[sudo] gem install jazzy
+```
+
+Build and package the SDK by using one of the following commands:
+
+* `make xpackage` builds a dynamic framework in the Debug configuration, including debug symbols.
+* `make xdocument` generates API documentation using jazzy.
+
+You can customize the build output by passing the following arguments into the `make` invocation:
+
+* `BUILDTYPE=Release` will optimize for distribution. Defaults to `Debug`.
+* `SYMBOLS=NO` strips the build output of any debug symbols, yielding much smaller binaries. Defaults to `YES`.
+
+An example command that creates a dynamic framework suitable for distribution:
+
+```bash
+make xpackage BUILDTYPE=Release SYMBOLS=NO
+```
+
+The products of these build commands can be found in the `build/macos/pkg` folder at the base of the repository.
+
## Contributing
### Making any symbol public