Note: This project is in the public domain. If you contribute any non-trivial patches or translations the following applies:
I dedicate any and all copyright interest in this software to the
public domain. I make this dedication for the benefit of the public at
large and to the detriment of my heirs and successors. I intend this
dedication to be an overt act of relinquishment in perpetuity of all
present and future rights to this software under copyright law.
- Fork SeriesGuide and clone your fork.
- See the notes about building the app below.
- Create a new branch (using GitHub
or the command
git checkout -b descriptive-branch-name dev). - Make great commits.
- Start a pull request and reference issues if needed.
- You can get help.
- You can suggest features.
- You can translate the app.
- You can discuss bugs or submit a bug.
devis the main development and test release branch.masterhas always the latest stable version.
To get started:
- Import the
SeriesGuidefolder as a new project in Android Studio. - Select the
pureDebugbuild variant (defined inapp/build.gradle). Learn about product flavors.
Debug builds should just work.
To add shows or movies you need to create API keys for
TheTVDB, TMDB
and OAuth credentials for trakt.
Place them in secret.properties in the project directory (where settings.gradle is):
SG_TVDB_API_KEY=<your api key>
SG_TMDB_API_KEY=<your api key>
SG_TRAKT_CLIENT_ID=<your trakt client id>
SG_TRAKT_CLIENT_SECRET=<your trakt client secret>
To release some additional secret.properties values might be necessary:
# Play Store in-app billing public key
SG_IAP_KEY_A=<keypart>
SG_IAP_KEY_B=<keypart>
SG_IAP_KEY_C=<keypart>
SG_IAP_KEY_D=<keypart>
# Credentials to publish the API jar
SONATYPE_NEXUS_USERNAME=<your sonatype username>
SONATYPE_NEXUS_PASSWORD=<your sonatype password>
To use Crashlytics create app/fabric.properties and
add your API key and secret:
# app/fabric.properties
apiSecret=<secret>
apiKey=<key>