Skip to content

Latest commit

 

History

History
65 lines (34 loc) · 2.31 KB

BUILD.md

File metadata and controls

65 lines (34 loc) · 2.31 KB
Raw

Build Umbrella

Requirements

  • Android Studio, fairly recent (version 2.2+, because of Gradle wrapper)
  • SDK24 which we build against
  • Android device with SDK 10 (IceCream Sandwich, 4.0.3) or above

Building the Source Code

1) Download and install Android Studio.

2) Launch Android Studio and select Get from Version Control from the Welcome Screen.

3) Another screen pops up. Ensure that Version control is set to Git. Enter https://github.com/securityfirst/Umbrella_android.git as the URL, then click Clone.

This process may take a bit, and you should see a dialog similar to this.

4) When the source code has downloaded, components will be loaded and the project will open in an Android Studio workspace.

5) Wait for Gradle to sync.

You'll need to be connected to the internet for this. If the process fails at any point, then select Sync project with Gradle Files from the File menu to restart the sync process.

It takes several minutes to download, install, verify and configure the required packages and tools.

6) If you want the development build, navigate to VCS > Git > Branches

Select the develop branch and Checkout

7) When Gradle sync is complete, select Build > Build Bundle(s)/APK(s) > Build APK(s) from the Android Studio menu.

8) When the build process finishes, click locate from the Event Log to open the folder containing the APK file, app-debug.apk. You can sideload this file onto any Android device.

Updating

9) Occasionally, you should check for updates. To get the latest version of the source code, select VCS > Update Project.

Alternatively, you can also use the Update Project button on the toolbar:

10) Choose whether to "Merge incoming changes into the current branch" or to "Rebase the current branch on top of incoming changes" and click OK to proceed.

11) Repeat steps 7 and 8 to build and install the updated app.