Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 2.01 KB

Contributing

If you would like to contribute code to SeriesGuide you can do so through GitHub by forking the repository and sending a pull request.

Branch structure

The repository is made up of two main branches: master (stable) and beta (development).

  • master has the latest stable code, its tags are released as SeriesGuide and SeriesGuide X on Google Play.
  • beta includes the latest unstable code. Its tags are released as SeriesGuide beta on Google Play.

Setup

This project is built with ADT using the Android library concept for dependency management. First, clone this repository. You will also need clones of my AndroidUtils, ActionBarSherlock, ViewPagerIndicator and SlidingMenu forks. Check out their seriesguide branches. See the project.properties files on how the projects depend on another. To successfully build, you should also create a keys.xml file in the SeriesGuide/res/values folder and add the string values

<resources>
    <string name="tvdb_apikey"></string>
    <string name="getglue_consumer_key"></string>
    <string name="getglue_consumer_secret"></string>
    <string name="trakt_apikey"></string>
</resources>

to it. These are not shared with the public mainly for security reasons.

To build any of the free, X or beta version use the appropiate flavor project. They all use the SeriesGuide project as an Android library project and just change the package names and icons as well as the Content Provider URI.