From 534421eb573ee5be1d88479850fabac0bec3ee76 Mon Sep 17 00:00:00 2001 From: Simeon J Morgan Date: Mon, 9 Nov 2015 21:27:33 +1100 Subject: [PATCH] Update build instructions with new URLs. Expand Android Studio steps. Closes #4462 --- BUILDING.md | 38 ++++++++++++++++++++------------------ 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index cf14c2fa16..89eed9ac02 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -1,22 +1,22 @@ -Building TextSecure -===================== +Building Signal +=============== Basics ------ -TextSecure uses [Gradle](http://gradle.org) to build the project and to maintain +Signal uses [Gradle](http://gradle.org) to build the project and to maintain dependencies. -Building TextSecure -------------------- +Building Signal +--------------- -The following steps should help you (re)build TextSecure from the command line. +The following steps should help you (re)build Signal from the command line. -1. Checkout the source somewhere on your filesystem with +1. Checkout the Signal-Android project source with the command: - git clone https://github.com/WhisperSystems/TextSecure.git + git clone https://github.com/WhisperSystems/Signal-Android.git -2. Make sure you have the [Android SDK](https://developer.android.com/sdk/index.html) installed somewhere on your system. +2. Make sure you have the [Android SDK](https://developer.android.com/sdk/index.html) installed. 3. Ensure that the following packages are installed from the Android SDK manager: * Android SDK Build Tools * SDK Platform @@ -38,8 +38,8 @@ Source assets tend to be large binary blobs, which are best stored outside of gi Sample command for generating our audio placeholder image: ```bash -pngs_from_svg.py ic_audio.svg /path/to/TextSecure/res/ 150 --color #000 --opacity 0.54 --suffix _light -pngs_from_svg.py ic_audio.svg /path/to/TextSecure/res/ 150 --color #fff --opacity 1.00 --suffix _light +pngs_from_svg.py ic_audio.svg /path/to/Signal/res/ 150 --color #000 --opacity 0.54 --suffix _light +pngs_from_svg.py ic_audio.svg /path/to/Signal/res/ 150 --color #fff --opacity 1.00 --suffix _light ``` Setting up a development environment @@ -48,13 +48,14 @@ 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. +2. Open Android Studio. On a new installation, the Quickstart panel will appear. If you have open projects, close them using "File > Close Project" to see the Quickstart panel. +3. From the Quickstart panel, choose "Configure" then "SDK Manager". +4. In the SDK Tools tab of the SDK Manager, make sure that the "Android Support Repository" is installed, and that the latest "Android SDK build-tools" are installed. Click "OK" to return to the Quickstart panel. +5. From the Quickstart panel, choose "Checkout from Version Control" then "git". +6. Paste the URL for the Signal-Android project when prompted (https://github.com/WhisperSystems/Signal-Android.git). +7. Android studio should detect the presence of a project file and ask you whether to open it. Click "yes". +9. Default config options should be good enough. +9. Project initialisation and build should proceed. Contributing code ----------------- @@ -67,3 +68,4 @@ 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 +