Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
32 lines (21 sloc) 800 Bytes

Contributing to DronecodeSDK-Swift

Before contributing, it's always a good idea to make a GitHub issue and get feedback from the project maintainers.

Build

To compile this framework, you need to build the dependencies first:

carthage build --platform ios --no-skip-current --verbose

Then you can open Dronecode-SDK-Swift.xcodeproj in XCode and build it, or do:

xcodebuild -scheme Dronecode-SDK-Swift

Generate docs

Note: The docs are generated in travis-ci for the master branch and pushed to a s3 bucket.

To test the doc generation locally, install jazzy:

gem install jazzy

Then, to generate the docs, just run:

./generate_docs.sh