Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken headings in Markdown files #205

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,45 @@
#Contributing to Connect SDK
# Contributing to Connect SDK

##General Questions
## General Questions

Please do not use GitHub issues for general questions about the SDK. Instead, use any of the following services to reach out to the development team:

- Twitter: [@ConnectSDK](https://twitter.com/ConnectSDK)
- Stack Overflow: [Connect-SDK tag](https://stackoverflow.com/tags/connect-sdk) (or [TV tag](https://stackoverflow.com/tags/tv))
- [[email protected]](mailto:[email protected])

##Versioning
## Versioning

We use [semantic versioning](http://semver.org/) in our tagged releases.

##Branching Strategy
## Branching Strategy

We use the [successful git branching model](http://nvie.com/posts/a-successful-git-branching-model/), except without release branches, and the `develop` branch is named `dev`.

##Bug Reports & Feature Requests
## Bug Reports & Feature Requests

We use [GitHub's issues](https://github.com/ConnectSDK/Connect-SDK-iOS/issues) system for managing bug reports and some upcoming features. Just open an issue and a member of the team will set the appropriate assignee, label, & milestone.

###Crash Reports
### Crash Reports

If you experience a crash, please attach your symbolicated crash log or stack trace to an issue in GitHub.

##Pull Requests
## Pull Requests

If you would like to submit code, please fork the repository on GitHub and develop in a feature branch, created from the latest `dev` commit. We do not accept pull requests on the `master` branch, as we only merge QA'd and tagged code into the `master` branch.

###Tests
### Tests

Please include unit/integration tests for the new/changed functionality with your pull request. It will help to verify the code is working as designed and make sure there are no regressions in future releases. Read more about our tests here: [README.md#tests](https://github.com/ConnectSDK/Connect-SDK-iOS/blob/dev/README.md#tests).

###Use of third party libraries
### Use of third party libraries

Connect SDK includes some third party libraries. If you'd like to integrate a library with a pull request, make sure that library has an open source license (MIT, Apache 2.0, etc).

###Licensing
### Licensing

If you submit a pull request, you acknowledge that your code will be released to the public under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html). Make sure that you have the rights to the code you are submitting in the pull request.

##Testing Lab
## Testing Lab

In the development of Connect SDK, we have gathered a number of devices for testing purposes. If you are contributing to and/or integrating Connect SDK and would like something tested in our lab, you may contact [[email protected]](mailto:[email protected]) with your request.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#Connect SDK iOS
# Connect SDK iOS

[![Build Status](https://travis-ci.org/ConnectSDK/Connect-SDK-iOS.svg)](https://travis-ci.org/ConnectSDK/Connect-SDK-iOS)
[![Code Coverage](https://img.shields.io/codecov/c/github/ConnectSDK/Connect-SDK-iOS/dev.svg)](https://codecov.io/github/ConnectSDK/Connect-SDK-iOS)
Expand All @@ -15,7 +15,7 @@ For more information, visit our [website](http://www.connectsdk.com/).
* [Platform documentation & FAQs](http://www.connectsdk.com/docs/ios/)
* [API documentation](http://www.connectsdk.com/apis/ios/)

##Dependencies
## Dependencies
This project has the following dependencies, some of which require manual setup. If you would like to use a version of the SDK which has no manual setup, consider using the [lite version](https://github.com/ConnectSDK/Connect-SDK-iOS-Lite) of the SDK.

* `libicucore.dylib`
Expand All @@ -28,8 +28,8 @@ This project has the following dependencies, some of which require manual setup.
* [Connect-SDK-iOS-FireTV](https://github.com/ConnectSDK/Connect-SDK-iOS-FireTV) submodule
- Requires [`AmazonFling.framework`](https://developer.amazon.com/public/apis/experience/fling/docs/amazon-fling-sdk-download)

##Including Connect SDK in your app
###Using CocoaPods
## Including Connect SDK in your app
### Using CocoaPods
1. Add `pod "ConnectSDK"` to your `Podfile`
2. Run `pod install`
3. Open the workspace file and run your project
Expand All @@ -38,7 +38,7 @@ This project has the following dependencies, some of which require manual setup.

You can use `pod "ConnectSDK/Core"` to get the [lite version](https://github.com/ConnectSDK/Connect-SDK-iOS-Lite).

###Without CocoaPods
### Without CocoaPods

1. Clone the repository (`git clone https://github.com/ConnectSDK/Connect-SDK-iOS.git`)
2. Set up the submodules by running the following command (in the `Connect-SDK-iOS/` directory in this example): `git submodule update --init`
Expand All @@ -55,7 +55,7 @@ You can use `pod "ConnectSDK/Core"` to get the [lite version](https://github.com
- [Connect-SDK-iOS-Google-Cast](https://github.com/ConnectSDK/Connect-SDK-iOS-Google-Cast)
- [Connect-SDK-iOS-FireTV](https://github.com/ConnectSDK/Connect-SDK-iOS-FireTV)

###Include Strings File for Localization (optional)
### Include Strings File for Localization (optional)
1. Locate the Connect SDK Xcode project in the Finder
2. Drag the ConnectSDKStrings folder into your project's library
3. You may make whatever changes you would like to the values and the SDK will use your strings file
Expand All @@ -80,23 +80,23 @@ The required third-party test frameworks are already pre-built and included in t

All of the test targets are compiled when the main `ConnectSDK` scheme is built, but only the unit tests are setup to run when testing the scheme. The other tests can be run by selecting the corresponding scheme.

##Limitations/Caveats
## Limitations/Caveats

###Subtitles
### Subtitles

- DLNA service supports `SRT` format only. Since there is no official specification for them, subtitles may not work on all DLNA-compatible devices. This feature has been tested and works on LG WebOS and Netcast TVs.
- Netcast service supports `SRT` format only, through DLNA.
- Google Cast service supports `WebVTT` format only. Servers providing subtitles and media files should support [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) headers (unless they are of the same origin). The simplest change is to send this HTTP response header for your files: `Access-Control-Allow-Origin: *`. More information is here: [https://developers.google.com/cast/docs/ios_sender#cors-requirements](https://developers.google.com/cast/docs/ios_sender#cors-requirements).
- FireTV service supports `WebVTT` format only. Subtitles on Fire TV are hidden by default. To display them, the user should manually pick one in the media player (click the "Options" button on the remote). The Fling SDK doesn't provide any way to make them appear remotely.
- WebOS service supports `WebVTT` format only. Server providing subtitles should support CORS headers, similarly to Cast service's requirements.

##Contact
## Contact
- Twitter: [@ConnectSDK](https://twitter.com/ConnectSDK)
- Ask a question on Stack Overflow with the [Connect-SDK tag](https://stackoverflow.com/tags/connect-sdk) (or [TV tag](https://stackoverflow.com/tags/tv))
- Developer Support: [[email protected]](mailto:[email protected])
- Partnerships: [[email protected]](mailto:[email protected])

##Credits
## Credits
Connect SDK for iOS makes use of the following projects, some of which are open-source:

* [Google Cast SDK](https://developers.google.com/cast/)
Expand Down Expand Up @@ -131,7 +131,7 @@ These projects are used in tests:

This public domain image is used in tests: [The San Francisco peaks of flagstaff public domain image](http://www.public-domain-image.com/free-images/nature-landscapes/peaks/the-san-francisco-peaks-of-flagstaff).

##License
## License
Copyright (c) 2013-2015 LG Electronics.

Licensed under the Apache License, Version 2.0 (the "License");
Expand Down