README.md 2.18 KB
Newer Older
Oliver Adams's avatar
Oliver Adams committed
1
Installation
2
============
Oliver Adams's avatar
Oliver Adams committed
3

4 5 6 7 8 9
There are two approaches to installing Aikuma:

Google Play
-----------

The simplest is to install it on an android phone via Google Play
Oliver Adams's avatar
Oliver Adams committed
10 11
(https://play.google.com/store/apps/details?id=org.lp20.aikuma).

12 13 14 15 16
Building from Source
--------------------

The second approach involves downloading the Aikuma source from Github and
building it.
Oliver Adams's avatar
Oliver Adams committed
17

18
Dependencies:
Oliver Adams's avatar
Oliver Adams committed
19 20
  * Android SDK (https://developer.android.com/sdk/index.html)
  * Android 4.2.2 SDK Platform (download using the `android` command included in the Android SDK)
21
  * Google Play Service library (http://developer.android.com/google/play-services/setup.html)
Oliver Adams's avatar
Oliver Adams committed
22 23
  * JDK 6 (for the Android SDK)
  * Apache Ant (for the Android SDK)
24 25 26 27 28 29 30
  * Gradle (to build aikuma-cloud-storage.jar)

Pre-installation steps:
  * Change the reference to Google Play Service library (http://developer.android.com/google/play-services/setup.html)
    1. Download Google Play Services from Android SDK Manager.
    2. Copy the library-folder($ANDROID_HOME/extras/google/google_play_services/libproject/google-play-services_lib) to the location you want.
    2. Check the ID of Android_4.2.2_API. This can be checked using `android list target`.
lisaslyis's avatar
lisaslyis committed
31 32
    3. type in `android update lib-project --target <target_ID> --path <path_to_the_copied_google_play_services_lib>`
    4. Change `../../workspace/google-play-services_lib` to <relative_path_to_google_play_services_lib> in Aikuma/project.properties
33 34 35 36 37 38 39
 
  * Build and move aikuma-cloud-storage library
    1. Install Gradle
    2. checkout the cloud-storage branch. `git checkout cloud-storage`
    3. Build the cloud-storage library. `cd AikumaCloudStorage`, `gradle publishToMavenLocal`
    4. Copy the cloud-storage library(~/.m2/repository/org/lp20/aikuma-cloud-storage/0.4.0/aikuma-cloud-storage-0.x.0.jar) to the location you want.
    5. checkout the Aikuma mobile app branch.(Latest test version is updated in search-interface branch). `git checkout search-interface`
lisaslyis's avatar
lisaslyis committed
40
    6. Replace any `aikuma-cloud-storage*.jar` with the built cloud-storage library to the folder(Aikuma/libs) 
41

42 43

With the dependencies installed and an Android phone connected to your computer, run:
Oliver Adams's avatar
Oliver Adams committed
44

Oliver Adams's avatar
Oliver Adams committed
45
`$ Aikuma/build.sh`
46 47

Aikuma should now be installed on your phone!
48 49