Overview

Bitbeaker - A Bitbucket client for Android

LICENSE

Licensed under the Apache License, Version 2.0. For complete licensing information and list of third party libraries used in this project, see LICENSE.md.

BUGS AND FEATURES

If you find a bug or need a feature, please report it to https://bitbucket.org/bitbeaker-dev-team/bitbeaker/issues. Please keep in mind that this is a free software with very few volunteers working on it in their free time. You should also check if the fix or feature is already mentioned in Next release section of Changelog. If it is, you can try the debug build.

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

CONTRIBUTION

Contribution is very welcome! If you want to add a feature or fix a bug yourself, please fork the repository at https://bitbucket.org/bitbeaker-dev-team/bitbeaker, do your changes and send a pull request. See also Contributing guidelines.

Getting started

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

[ui]
username = John Doe <john@example.com>

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 gradle.properties.template to gradle.properties 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. Check from app/build.gradle which versions are required from these:
      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 http://developer.android.com/sdk/installing/index.html -> 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: Import Project -> select settings.gradle

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

Translations

Translations are very welcome! Please use https://crowdin.com/project/bitbeaker.

CONTACT

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

We are also testing public HipChat channel. You can join it at http://www.hipchat.com/gUetcIqT8

Project Status

Build Status: bitbeaker-dev-team/bitbeaker Crowdin