Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.



If you find a bug or need a feature, please report it to Please keep in mind that this is free software with very few volunteers working on it in their free time.

In many cases a stacktrace from crash is appreciated. If you can't get it via IDE, you can try aLogcat.


Contribution is very welcome! If you want to add a feature or fix a bug yourself, please fork the repository at, do your changes and send a pull request.

Getting started

First make sure you have set a username in Mercurial. Add something like this to ~/.hgrc (*nix) or %USERPROFILE%\Mercurial.ini (Windows):

username = John Doe <>

For your own developing, register yourself a new OAuth consumer in Bitbucket (Manage account -> Integrated applications -> Add consumer).

The rest of this guide assumes you use Android Studio and Gradle build system:

  1. Clone the project to your local computer without using Android Studio yet.
  2. Copy to and fill in your OAuth key and secret.
  3. Define the ANDROID_HOME environment variable which points to your Android SDK. (If you don't want to use bundled SDK from Android Studio)
  4. Using SDK Manager, install
    1. Android Support Repository
    2. Required versions of the following, defined in build.gradle
      1. Android SDK Tools
      2. Android SDK Platform-tools
      3. Android SDK Build-tools
      4. SDK Platform (Android API)
  5. Linux: Android SDK Tools may require installing ia32-libs (See -> Information for other platforms -> Getting started on Linux -> Troubleshooting Ubuntu)
  6. (At this point you should get BUILD SUCCESSFUL when running ./gradlew assembleDebug)
  7. Import into Android Studio
    1. Import Project -> select build.gradle
    2. Use gradle wrapper

More tips using Android Studio can be found in our Wiki.


Translations are very welcome! Please use

Alternatively send a pull request. Useful resources:


We have IRC channel #bitbeaker on the Freenode IRC network ( You may access IRC through web chat if you don't have IRC client installed already.


Build Status