session-android/BUILDING.md

Building Session
===============

Basics
------

Session uses [Gradle](http://gradle.org) to build the project and to maintain
dependencies.  However, you needn't install it yourself; the
"gradle wrapper" `gradlew`, mentioned below, will do that for you.

Dependencies
---------------
You will need Java 8 set up on your machine.

Ensure that the following packages are installed from the Android SDK manager:

* Android SDK Build Tools (see buildToolsVersion in build.gradle)
* SDK Platform (all API levels)
* Android Support Repository
* Google Repository

In Android studio, this can be done from the Quickstart panel. Just choose "Configure", then "SDK Manager". In the SDK Tools tab of the SDK Manager, make sure that "Android Support Repository" is installed, and that the latest "Android SDK build-tools" are installed. Click "OK" to return to the Quickstart panel. You may also need to install API version 28 in the SDK platforms tab.

Setting up a development environment and building from Android Studio
------------------------------------

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

1. 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.
2. From the Quickstart panel, choose "Checkout from Version Control" then "git".
3. Paste the URL for the session-android project when prompted (https://github.com/oxen-io/session-android.git).
4. Android Studio should detect the presence of a project file and ask you whether to open it. Click "yes".
5. Default config options should be good enough.
6. Project initialization and building should proceed.
7. Clone submodules with `git submodule update --init --recursive`

If you would like to build the Huawei Flavor with Huawei HMS push notifications you will need to pass 'huawei' as a command line arg to include the required dependencies.

e.g. `./gradlew assembleHuaweiDebug -Phuawei`

If you are building in Android Studio then add `-Phuawei` to `Preferences > Build, Execution, Deployment > Gradle-Android Compiler > Command-line Options`

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).
Update BUILDING.md 2020-04-07 23:05:36 +00:00			`Building Session`
Update build instructions with new URLs. Expand Android Studio steps. Closes #4462 2015-11-09 10:27:33 +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
Update BUILDING.md 2020-04-07 23:05:36 +00:00			`Session uses [Gradle](http://gradle.org) to build the project and to maintain`
Some clarifications for BUILDING.md Closes #4501 // FREEBIE 2015-11-12 20:33:17 +00:00			`dependencies. However, you needn't install it yourself; the`
			"gradle wrapper" `gradlew`, mentioned below, will do that for you.
add BUILDING instructions 2013-06-18 09:38:11 +00:00
Update BUILDING.md 2020-05-27 01:49:18 +00:00			`Dependencies`
Update build instructions with new URLs. Expand Android Studio steps. Closes #4462 2015-11-09 10:27:33 +00:00			`---------------`
Update BUILDING.md 2020-05-27 01:49:18 +00:00			`You will need Java 8 set up on your machine.`
Added more build information to BUILDING.md Added more instructions about setting up a development environment. 2014-03-04 08:06:41 +00:00
Update BUILDING.md 2020-05-27 01:49:18 +00:00			`Ensure that the following packages are installed from the Android SDK manager:`
Update BUILDING.md 2020-06-03 00:51:40 +00:00
			`* Android SDK Build Tools (see buildToolsVersion in build.gradle)`
Update BUILDING 2021-05-24 03:22:17 +00:00			`* SDK Platform (all API levels)`
Update BUILDING.md 2020-06-03 00:51:40 +00:00			`* Android Support Repository`
			`* Google Repository`
Fix build 2020-06-03 01:23:04 +00:00
Update BUILDING 2021-05-24 03:22:17 +00:00			`In Android studio, this can be done from the Quickstart panel. Just choose "Configure", then "SDK Manager". In the SDK Tools tab of the SDK Manager, make sure that "Android Support Repository" is installed, and that the latest "Android SDK build-tools" are installed. Click "OK" to return to the Quickstart panel. You may also need to install API version 28 in the SDK platforms tab.`
Fix build 2020-06-03 01:23:04 +00:00
Update BUILDING.md 2020-05-27 01:49:18 +00:00			`Setting up a development environment and building from 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			`------------------------------------`

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

Update BUILDING.md 2020-05-27 01:49:18 +00:00			`1. 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.`
			`2. From the Quickstart panel, choose "Checkout from Version Control" then "git".`
feat: update the repo documentation readme and building file 2021-04-09 03:43:47 +00:00			`3. Paste the URL for the session-android project when prompted (https://github.com/oxen-io/session-android.git).`
Update BUILDING.md 2020-05-27 01:49:18 +00:00			`4. Android Studio should detect the presence of a project file and ask you whether to open it. Click "yes".`
			`5. Default config options should be good enough.`
Fix build 2020-06-03 01:23:04 +00:00			`6. Project initialization and building should proceed.`
build: submodule build command update 2023-07-14 08:31:25 +00:00			7. Clone submodules with `git submodule update --init --recursive`
Update BUILDING.md 2020-05-27 01:49:18 +00:00
Add huawei info to BUILDING.md 2023-08-15 05:22:40 +00:00			`If you would like to build the Huawei Flavor with Huawei HMS push notifications you will need to pass 'huawei' as a command line arg to include the required dependencies.`

			e.g. `./gradlew assembleHuaweiDebug -Phuawei`

			If you are building in Android Studio then add `-Phuawei` to `Preferences > Build, Execution, Deployment > Gradle-Android Compiler > Command-line Options`

Added more build information to BUILDING.md Added more instructions about setting up a development environment. 2014-03-04 08:06:41 +00:00			`Contributing code`
			`-----------------`

Update BUILDING 2021-05-24 03:22:17 +00:00			`Code contributions should be sent via Github as pull requests, from feature branches [as explained here](https://help.github.com/articles/using-pull-requests).`