From 35eeaa9bd52a08d64186b093288ced789c7b0abe Mon Sep 17 00:00:00 2001
From: Chris Glass <tribaal@gmail.com>
Date: Tue, 4 Mar 2014 09:06:41 +0100
Subject: [PATCH] Added more build information to BUILDING.md

Added more instructions about setting up a development environment.
---
 BUILDING.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++----
 README.md   |  3 +++
 2 files changed, 52 insertions(+), 4 deletions(-)

diff --git a/BUILDING.md b/BUILDING.md
index 8a60bf59c..61f4e48bc 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -1,11 +1,30 @@
 Building TextSecure
-===================
+=====================
 
-1. Ensure the 'Android Support Repository' is installed from the Android SDK manager.
+Basics
+------
 
-Execute Gradle:
+TextSecure uses [Gradle](http://gradle.org) to build the project and to maintain
+dependencies.
 
-    ./gradlew build
+Building TextSecure
+-------------------
+
+The following steps should help you (re)build TextSecure from the command line.
+
+1. Checkout the source somewhere on your filesystem with 
+
+        git clone https://github.com/WhisperSystems/TextSecure.git
+
+2. Make sure you have the [Android SDK](https://developer.android.com/sdk/index.html) installed somewhere on your system.
+3. Ensure the "Android Support Repository" is 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
 
 Re-building native components
 -----------------------------
@@ -20,3 +39,29 @@ Execute ndk-build:
     ndk-build
 
 Afterwards, execute Gradle as above to re-create the APK.
+
+Setting up a development environment
+------------------------------------
+
+[Android Studio](https://developer.android.com/sdk/installing/studio.html) 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 TextSecure project when prompted (https://github.com/WhisperSystems/TextSecure.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](https://help.github.com/articles/using-pull-requests).
+
+Mailing list
+------------
+
+Development discussion happens on the whispersystems mailing list.
+[To join](https://lists.riseup.net/www/info/whispersystems)
+Send emails to whispersystems@lists.riseup.net
diff --git a/README.md b/README.md
index 3d59a0f0b..56fc382a9 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,9 @@ Current BitHub Payment For Commit:
 =================
 [![Current Price](https://bithub.herokuapp.com/v1/status/payment/commit/)](https://whispersystems.org/blog/bithub/)
 
+Building and contributing code
+==============================
+Instructions on how to build TextSecure, as well as on how to setup an IDE to modify it can be found in the "BUILDING.md" file.
 
 Bug tracker
 -----------