Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 2.03 KB

BUILDING.md

File metadata and controls

53 lines (36 loc) · 2.03 KB

Building Flock

Basics

Flock uses Gradle to build the project and to maintain dependencies.

Building Flock

The following steps should help you (re)build flock from the command line.

  1. Checkout the source somewhere on your filesystem with

     git clone https://github.com/WhisperSystems/Flock.git
    
  2. Make sure you have the Android SDK installed somewhere on your system.

  3. Ensure the "Android Support Repository" and "Android SDK Build-tools" are installed from the Android SDK manager.

  4. Create a local.properties file at the root of your source checkout and add an sdk.dir entry to it.

     sdk.dir=\<path to your sdk installation\>
    
  5. Execute Gradle:

     ./gradlew build
    

Setting up a development environment

Android Studio is the recommended development environment.

  1. Install Android Studio
  2. Make sure the "Android Support Repository" is installed in the Android Studio SDK.
  3. Make sure the latest "Android SDK build-tools" is installed in the Android Studio SDK.
  4. Create a new Android Studio project. from the Quickstart pannel (use File > Close Project to see it), choose "Checkout from Version Control" then "git".
  5. Paste the URL for the Flock project when prompted (https://github.com/rhodey/securesync.git)
  6. Android studio should detect the presence of a project file and ask you wethere to open it. Click "yes".
  7. Default config options should be good enough.
  8. Project initialisation and build should proceed.

Contributing code

Code contributions should be sent via github as pull requests, from feature branches as explained here.

Mailing list

Development discussion happens on the whispersystems mailing list. To join Send emails to whispersystems@lists.riseup.net