Rabbit Reminder

A simple geolocalized to-do list application for Google Android.

Build Rabbit Reminder

You'll need a working android sdk installed with the android sdk 1.5 image in order to build this application.

You must define an environment variable ANDROID_HOME which defines the path to your android sdk directory. The path to the android tools folder must be in your PATH environment variable.

###Build the application with Eclipse

Open a new Eclipse workspace and click File > Import > General > Existing project into workspace. Then in the Select root directory field, write the path to the Rabbit Reminder folder.

Do the same thing for the Rabbit Reminder Test folder if you want to build the unit & functional tests.

The workspace should be built automatically by Eclipse: if not, click Project > Build All.

If it don't build correctly

• Check that projects are synchronized with Eclipse by selecting them and pressing F5
• Check that projects properties are correct by right clicking on them and choose Android Tools > Fix Project Properties
• Suppress generated classes as the R.java class and rebuild the whole project.

Build the application with Ant

Go to the Rabbit Reminder directory and enter the command

android update project -p .

to update the build.xml script with your local configuration. You can now build the main project with Ant.

To build the test project, you need to go into the Rabbit Reminder Test directory and enter the command

android update test-project -p . -m "../Rabbit Reminder Test"

to update the build script. You can now build the test projet with ant release and you can run tests with ant run-tests (an emulator needs to be started before running any tests).

If it don't build correctly

• Check that both emulator and sdk images are up-to-date
• Check the state of your ANDROID_HOME environment variable
• Check that the path inside your local.properties file points to the right directory (the root of the android sdk)

Setting Maps API key

This application use the Google Maps API to work, so you need a Maps API key in order to make it work properly (refer to the Android document if you don't know how to generate a Maps API key).

To set up the key, simply create a XML file called \Rabbit Reminder\res\values\keys.xml with the following content :

<?xml version="1.0" encoding="utf-8"?>
<resources>
	<string name="maps_api_key">[[YOUR API KEY GOES HERE]]</string>
</resources>