aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: c31baba3de22f65c36c95dedf845f54055b59b13 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
[c:geo](http://www.cgeo.org) is a simple yet powerful unofficial geocaching client for Android devices. In contrast to other similar applications, c:geo doesn't require a web browser nor file exports. You can just go geocaching with your phone and without any home preparation or worries. Of course, you can go without paying - it's free.

Get the source
--------------

Fork the project source code on [github](https://github.com/cgeo/c-geo-opensource):

	git clone git://github.com/cgeo/c-geo-opensource.git

Build
-----

### Prerequisites ###

- [Android SDK](http://developer.android.com/sdk) 2.2 including Google APIs V8
- [Google USB Driver](http://developer.android.com/sdk/win-usb.html) to install the application on the smartphone
- [Ant](http://ant.apache.org) 1.6.0+ for building c:geo on the command line (not necessary when using only Eclipse)

### Structure ###

c:geo sources and executables are located in the `main` directory. Tests are located in the `tests` directory.

### Known limitations ###

If the workspace directory name contains a space and leads to errors in the -dex Ant target, then you need to set the property "basedir" in your `local.properties` to the 8.3 name of the directory where this script is located on your disk.

### Configuration ###

1. copy `./templates/private.properties` to `./`
2. edit `private.properties` (see comments in the file)
3. copy `./templates/local.properties` to `./`
4. edit `local.properties` (see comments in the file)
5. copy `./templates/mapsapikey.xml` to `./res/values/`
6. edit `./res/values/mapsapikey.xml` and insert your Maps API key (see comments in the file)

### Building with Ant ###

Run one of the following commands in `./`

    ant help
    ant clean
    ant debug
    ant release

or use the Ant view of Eclipse

### Debugging ###

1. Add android:debuggable="true" in the application settings of `AndroidManifest.xml`
2. In Eclipse, create a Debug Configuration for an Android Application using the menu Run->Debug Configurations

License
-------

c:geo is distributed under [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).

Contact
-------

- original author: Radovan Paska aka carnero
- questions: support@cgeo.org
- website: http://www.cgeo.org/
- support: support@cgeo.org
- twitter: http://twitter.com/android_gc
- facebook: http://www.facebook.com/android.geocaching