session-android/BUILDING.md

Building TextSecure
=====================

Basics
------

TextSecure uses [Gradle](http://gradle.org) to build the project and to maintain
dependencies.

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 that the following packages are installed from the Android SDK manager:
    * Android SDK Build Tools
    * SDK Platform
    * Android Support Repository
    * Google Repository
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
-----------------------------

Note: This step is optional; native components are contained as binaries (see [libaxolotl/libs](libaxolotl/libs)).

1. Ensure that the Android NDK is installed.

Execute ndk-build:

    cd libaxolotl
    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 whether 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
add BUILDING instructions 2013-06-18 09:38:11 +00:00			`Building TextSecure`
Added more build information to BUILDING.md Added more instructions about setting up a development environment. 2014-03-04 08:06:41 +00:00			`=====================`
add BUILDING instructions 2013-06-18 09:38:11 +00:00
Added more build information to BUILDING.md Added more instructions about setting up a development environment. 2014-03-04 08:06:41 +00:00			`Basics`
			`------`
add BUILDING instructions 2013-06-18 09:38:11 +00:00
Added more build information to BUILDING.md Added more instructions about setting up a development environment. 2014-03-04 08:06:41 +00:00			`TextSecure uses [Gradle](http://gradle.org) to build the project and to maintain`
			`dependencies.`
add BUILDING instructions 2013-06-18 09:38:11 +00:00
Added more build information to BUILDING.md Added more instructions about setting up a development environment. 2014-03-04 08:06:41 +00:00			`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.`
add dependencies to BUILDING.md // FREEBIE Closes #1809 2014-08-07 21:49:42 +00:00			`3. Ensure that the following packages are installed from the Android SDK manager:`
			`* Android SDK Build Tools`
			`* SDK Platform`
			`* Android Support Repository`
			`* Google Repository`
Added more build information to BUILDING.md Added more instructions about setting up a development environment. 2014-03-04 08:06:41 +00:00			`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`
Build native code for multiple architectures. * Include native libs without requiring intermediate .jar. * Fix build warnings; use latest build tools. 2014-02-25 08:35:55 +00:00
			`Re-building native components`
			`-----------------------------`

path changed: library -> libaxolotl 2014-12-01 15:09:55 +00:00			`Note: This step is optional; native components are contained as binaries (see [libaxolotl/libs](libaxolotl/libs)).`
Build native code for multiple architectures. * Include native libs without requiring intermediate .jar. * Fix build warnings; use latest build tools. 2014-02-25 08:35:55 +00:00
			`1. Ensure that the Android NDK is installed.`

			`Execute ndk-build:`

path changed: library -> libaxolotl 2014-12-01 15:09:55 +00:00			`cd libaxolotl`
Build native code for multiple architectures. * Include native libs without requiring intermediate .jar. * Fix build warnings; use latest build tools. 2014-02-25 08:35:55 +00:00			`ndk-build`

			`Afterwards, execute Gradle as above to re-create the APK.`
Added more build information to BUILDING.md Added more instructions about setting up a development environment. 2014-03-04 08:06:41 +00:00
			`Setting up a development environment`
			`------------------------------------`

			`[Android Studio](https://developer.android.com/sdk/installing/studio.html) is the recommended development environment.`

Update BUILDING.md Correction of a typo and a few style incongruences. // FREEBIE Closes #1750 2014-07-27 17:57:36 +00:00			`1. Install Android Studio.`
Added more build information to BUILDING.md Added more instructions about setting up a development environment. 2014-03-04 08:06:41 +00:00			`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".`
Update BUILDING.md Correction of a typo and a few style incongruences. // FREEBIE Closes #1750 2014-07-27 17:57:36 +00:00			`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 whether to open it. Click "yes".`
Added more build information to BUILDING.md Added more instructions about setting up a development environment. 2014-03-04 08:06:41 +00:00			`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`