Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

Commit

Permalink
[macos] Add 'Packaging builds' section to developing doc
Browse files Browse the repository at this point in the history
  • Loading branch information
friedbunny committed Sep 30, 2016
1 parent 6723a61 commit a8e15e8
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions platform/macos/DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a8e15e8

Please sign in to comment.