blob: 0516d54536e3ecac69b00ee4d70dca4f4789ba01 [file] [log] [blame] [view]
Alexander Afanasyev087c7c12015-02-02 00:21:21 -08001NFD on Android
2==============
3
Alexander Afanasyev808ce312016-01-23 18:11:59 -08004[![Build Status](https://travis-ci.org/named-data-mobile/NFD-android.svg?branch=master)](https://travis-ci.org/named-data-mobile/NFD-android)
Alexander Afanasyev087c7c12015-02-02 00:21:21 -08005
6## Prerequisites
7
8To compile code, the following is necessary
9
Alexander Afanasyeva4091562016-02-23 11:51:31 -080010- Recent version of [Android SDK](http://developer.android.com/sdk/index.html), android-23 SDK
11 and 23.0.2 build tools (for build), android-19 SDK (for compatibility), and several other SDK
Alexander Afanasyevf3812562016-01-21 16:28:33 -080012 components
13- [CrystalX Android NDK](https://www.crystax.net/en/download) version 10.3.1
Alexander Afanasyev087c7c12015-02-02 00:21:21 -080014
15Example script for Ubuntu 14.04 to get all dependencies, download SDK and NDK:
16
Alexander Afanasyevf3812562016-01-21 16:28:33 -080017 CRYSTAX_NDK_VERSION=10.3.1
Alexander Afanasyevf3812562016-01-21 16:28:33 -080018 SDK_VERSION=24.4.1
Alexander Afanasyev087c7c12015-02-02 00:21:21 -080019
Alexander Afanasyeva4091562016-02-23 11:51:31 -080020 BUILD_TOOLS_VERSION=23.0.2
21 COMPILE_SDK_VERSION=23
Alexander Afanasyev087c7c12015-02-02 00:21:21 -080022
Alexander Afanasyevf3812562016-01-21 16:28:33 -080023 sudo apt-get install -y build-essential git openjdk-7-jdk unzip
Alexander Afanasyeva4091562016-02-23 11:51:31 -080024 sudo apt-get install -y lib32stdc++6 lib32z1 lib32z1-dev
Alexander Afanasyevf3812562016-01-21 16:28:33 -080025
26 wget https://www.crystax.net/download/crystax-ndk-$CRYSTAX_NDK_VERSION-linux-x86_64.tar.xz
27 tar xf crystax-ndk-$CRYSTAX_NDK_VERSION-linux-x86_64.tar.xz
28 rm crystax-ndk-$CRYSTAX_NDK_VERSION-linux-x86_64.tar.xz
29
30 wget http://dl.google.com/android/android-sdk_r$SDK_VERSION-linux.tgz
31 tar zxf android-sdk_r$SDK_VERSION-linux.tgz
32 rm android-sdk_r$SDK_VERSION-linux.tgz
Alexander Afanasyev087c7c12015-02-02 00:21:21 -080033
34 export ANDROID_HOME=`pwd`/android-sdk-linux
35 export PATH=${PATH}:${ANDROID_HOME}/tools:${ANDROID_HOME}/platform-tools
36
Alexander Afanasyevf3812562016-01-21 16:28:33 -080037 echo "y" | android update sdk --filter platform-tools,build-tools-$BUILD_TOOLS_VERSION,android-$COMPILE_SDK_VERSION,extra-android-support,extra-android-m2repository,extra-google-m2repository --no-ui --all --force
38 echo "y" | android update sdk --filter "android-19" --no-ui --all --force
Alexander Afanasyev087c7c12015-02-02 00:21:21 -080039
Alexander Afanasyev087c7c12015-02-02 00:21:21 -080040## Building
41
42
43 git clone --recursive http://gerrit.named-data.net/NFD-android
44 echo sdk.dir=`pwd`/android-sdk-linux > NFD-android/local.properties
Alexander Afanasyevf3812562016-01-21 16:28:33 -080045 echo ndk.dir=`pwd`/crystax-ndk-10.3.1 >> NFD-android/local.properties
Alexander Afanasyev087c7c12015-02-02 00:21:21 -080046 cd NFD-android
47
Alexander Afanasyev7395caf2016-01-31 10:33:28 -080048 ./gradlew assembleRelease
Alexander Afanasyev087c7c12015-02-02 00:21:21 -080049
50
51## Setting up environment using Vagrant
52
53The development setup can be set up with [Vagrant](https://www.vagrantup.com/) and scripts provided
54in `.vagrant/` folder. After vagrant command-line is installed, the following will create VM
55environment and fetch all necessary dependencies:
56
57 cd .vagrant
58 vagrant up
Alexander Afanasyev81e7d872015-04-19 19:38:26 -070059 vagrant ssh
Alexander Afanasyev087c7c12015-02-02 00:21:21 -080060
61Refer to vagrant documentation for more information.