diff --git a/content/page/building.md b/content/page/building.md index 5d09887122aa884e33609ec3bf1f73c2d2140d75..19fbec4f2065ae57ac1a0ab55ffbd77025b31560 100644 --- a/content/page/building.md +++ b/content/page/building.md @@ -5,45 +5,48 @@ aliases: title: Building the Source Code --- -1\) Download and install [Android -Studio](http://developer.android.com/sdk/index.html). +1\) Download and install [Android Studio](http://developer.android.com/sdk/index.html). - - - -3\) Select **Git** from the popup menu. +2\) Launch Android Studio and select **Get from Version Control** from the Welcome Screen.  -4\) Enter **https://code.briarproject.org/briar/briar.git** as the **Git -Repository URL**, then click **Clone**. +3\) Another screen pops up. Ensure that **Version control** is set to **Git**.  +4\) Enter **https://code.briarproject.org/briar/briar.git** as the **URL**, then click **Clone**. + + + This process may take a bit, and you should see a dialog similar to this. - + -5\) When the source code has downloaded, click **Yes** to open the -project. +5\) When the source code has downloaded, components will be loaded and the project will open in an Android Studio workspace. - +6\) Wait for Gradle to sync. -6\) Select **Build > Build Bundle(s)/APK(s) > Build APK(s)** from the Android Studio menu. +You may be unable to successfully build Briar due to the error: *It is not fully supported to define distributionSha256Sum in gradle/wrapper/gradle-wrapper.properties...* - +To resolve this error, click the link that says **Use "c9910513d..." as checksum for https://services.gradle.org/distributions/gradle-6.5-all.zip and sync project** from the Event Log. -7\) When the build process finishes, click **Show in File Manager** to -open the folder containing the APK file, **briar-android-official-debug.apk**. -You can -[sideload](http://www.digitalcitizen.life/how-sideload-apps-using-apk-files-android-devices) -this file onto any Android device. +It takes several minutes to download, install, verify and configure the required packages and tools. If the sync process fails at any point, select **Sync project with Gradle Files** from the **File** menu to restart the process. - + -8\) Briar is under constant development, so you should check for updates -regularly. To get the latest version of the source code, select **VCS > Update -Project**. +7\) Follow [Android Studio's documentation](https://developer.android.com/studio/run/device) to set up a device to run your app on. + +8\) If a device has been properly set up, you should see it under **Running devices** in the target device drop-down menu. Select the device and click run button (or select **Run** > **Run 'briar-android'** from the menu). + + + +Android Studio builds the app, then installs and launches it under the name "Briar Debug" on the selected device. + +## Updating + +9\) Briar is under constant development, so you should check for updates +regularly. To get the latest version of the source code, select **VCS** > **Update Project**.  @@ -51,12 +54,11 @@ Alternatively, you can also use the **Update Project** button on the toolbar:  -9\) Click **OK** to accept the default settings. +10\) Choose whether to "Merge incoming changes into the current branch" or to "Rebase the current branch on top of incoming changes" (Recommended) and click **OK** to proceed.  -10\) Repeat steps 6 and 7 to build and install the updated app. +11\) Repeat steps 7 and 8 to build and install the updated app. + +If you’re interested in getting involved or following the progress of the project, please [don't hesitate to get in touch](/get-involved). -If you're interested in getting involved or following the progress of -the project, please [join the development mailing -list](https://lists.sourceforge.net/lists/listinfo/briar-devel). diff --git a/static/img/building/01.png b/static/img/building/01.png deleted file mode 100644 index 0f4810b25377cc57cd44a18d1469af8120e96fcd..0000000000000000000000000000000000000000 Binary files a/static/img/building/01.png and /dev/null differ diff --git a/static/img/building/02.png b/static/img/building/02.png index b278593802ee987cf56253ca6a313fa3abf638a6..efde9d4e7104c8a67f7dabad7fab83004b97a2a7 100644 Binary files a/static/img/building/02.png and b/static/img/building/02.png differ diff --git a/static/img/building/03-2.png b/static/img/building/03-2.png deleted file mode 100644 index a5aae4e7adc58d031f0c5e94c9e62c7b75fba3eb..0000000000000000000000000000000000000000 Binary files a/static/img/building/03-2.png and /dev/null differ diff --git a/static/img/building/03.png b/static/img/building/03.png index 0e25046a1e3a206cd35e844dab01d051a0ba7b55..70e79c947ed16db09636712e955d92537f20b7be 100644 Binary files a/static/img/building/03.png and b/static/img/building/03.png differ diff --git a/static/img/building/04-2.png b/static/img/building/04-2.png new file mode 100644 index 0000000000000000000000000000000000000000..1426be06c1c4ca17a8e299ce6e188f03140b9ec5 Binary files /dev/null and b/static/img/building/04-2.png differ diff --git a/static/img/building/04.png b/static/img/building/04.png index e64509ab443ec7e53952015e90e8ea0ac8d3189e..b14925144d6192e2d75d0b31554bbce25943dac8 100644 Binary files a/static/img/building/04.png and b/static/img/building/04.png differ diff --git a/static/img/building/06.png b/static/img/building/06.png new file mode 100644 index 0000000000000000000000000000000000000000..055e965354a141c8a7b956dd77a10cdb133b5446 Binary files /dev/null and b/static/img/building/06.png differ diff --git a/static/img/building/08.png b/static/img/building/08.png new file mode 100644 index 0000000000000000000000000000000000000000..2a3f07bc65cf26b52ad5c1f855faf4db19185f45 Binary files /dev/null and b/static/img/building/08.png differ diff --git a/static/img/building/10.png b/static/img/building/10.png index 94c51810a06201691be522d2a1e9ab3c77d6c56b..844a82263966a32ab130dbedd254e8289613b61e 100644 Binary files a/static/img/building/10.png and b/static/img/building/10.png differ diff --git a/static/img/building/13.png b/static/img/building/7.png similarity index 100% rename from static/img/building/13.png rename to static/img/building/7.png diff --git a/static/img/building/11.png b/static/img/building/8.png similarity index 100% rename from static/img/building/11.png rename to static/img/building/8.png