-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Sample App guidelines
THE DOCUMENTATION FOR REALM IS AVAILABLE AT HTTP://REALM.IO
When creating a sample iOS app, please follow these guidelines:
Repo Structure: should include a README, optionally a screenshot of the app in action, a license file.
README Contents: README should have a "How To Run" section with detailed steps to make it run on a fresh install of OS X. README should also include a screenshot of the app in action if applicable.
CocoaPods: should be used whenever possible to ensure that the sample apps are tied to a specific version of the framework. All cocoapods files should be included except for those in the Pods/ directory. That means that Podfile, Podfile.lock and SampleApp.xcworkspace should all be checked in.
.gitignore: the .gitignore file found here should be used as a starting off point for your sample app.