README-DEVEL

==================================================
REQUIREMENTS
==================================================
1. Android SDK
2. Maven version 3.0.3 or above
3. Google Protobuf version 4.2.1

==================================================
PRE-BUILD STEPS
==================================================
1. As mentioned in http://dev.umitproject.org/issues/450 the central Maven repository does not have the Google Maps API or the OSMDroid API. Therefore, both need to be manually install in the local Maven repository.
This is the general template of the command that needs to be executed for each manual Maven artifact installation:
mvn install:install-file  -Dfile=path-to-your-artifact-jar \
                          -DgroupId=your.groupId \
                          -DartifactId=your-artifactId \
                          -Dversion=version \
                          -Dpackaging=jar \
                          -DlocalRepositoryPath=path-to-specific-local-repo

The libs which are needed by the ICM Agent but aren't present in the Maven repository are:
a. Google Maps API 4
b. OSMDroid 3.0.4

These can be downloaded from: http://dev.umitproject.org/projects/icm-mobile/files

Alternatively, Linux users can simply use the script 'deps.sh' to install these dependencies in the local Maven repository.

2. The message.proto is present in icm-common, therefore it needs to be added as a submodule to the mobile agent.
In the outer most folder:
a. git submodule init
b. git submodule update --rebase

==================================================
RUNNING UNIT TESTS
==================================================
In the outer most folder:
1. mvn clean install

==================================================
BUILDING AND DEPLOYING THE APP ON THE EMULATOR
==================================================
In folder "icm-mobile":
1. mvn clean install android:deploy

==================================================
USER GUIDE
==================================================
http://dev.umitproject.org/projects/icm-mobile/wiki

==================================================
APP OVERVIEW
==================================================
http://blog.umitproject.org/2011/07/icm-mobile-agent.html

==================================================
GIT REPOSITORY PUBLIC ACCESS
==================================================
git clone http://git.umitproject.org/icm-mobile.git

==================================================
GIT REPOSITORY DEVEL ACCESS
==================================================
git clone umitgit@dev.umitproject.org:/icm-mobile.git

==================================================
Other useful links
==================================================
1. Mobile agent screen-shot walkthrough: http://blog.umitproject.org/2011/08/openmonitor-mobile-agent-screenshot.html
2. Working on a large-scale Android project: http://blog.umitproject.org/2011/08/mobile-woes-working-on-large-scale.html
3. Common JUnit error: http://blog.umitproject.org/2011/08/junit-javalangverifyerror-failure-in.html
4. Using Protobuf in Android and Maven: http://blog.umitproject.org/2011/08/using-google-protobufs-in-android-and.html
5. Using Apache Maven as a build manager for Android projects: http://blog.umitproject.org/2011/05/using-apache-maven-as-build-manager-for.html
6. i10n and L8n in Android: http://blog.umitproject.org/2011/05/i10n-and-l8n-in-android.html
7. Unstaged Changes in Git: http://blog.umitproject.org/2011/05/unstaged-changes-in-git.html