Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100755 61 lines (50 sloc) 1.848 kb
74aa1e0 @mathiask added HACKING.md
mathiask authored
1 Setting up the build environment
2 ================================
3
4 Prerequisites
5 -------------
6 * Java SDK >= 1.6
7 * ant >= 1.8
8 * APIs in Android SDK Manager, currently
9 * 13 (Android 3.2) for ActionBarSherlock
10 * 15 (Android 4.0.3) for the rest
11 * defined in project.properties
12 * source code cloned from github
13 * (optional Eclipse with Android plugins)
14
15 To get a working environment `cd` to the mobileorg-android directory and
16 perform the following steps:
17
18 Setup
19 -----
20 * run `./setup.sh`
21
22 Build
23 -----
24 * run `ant debug`
25
26 If you don't get an error, you managed to compile the project. The .apk files
67228bf @matburt More HACKING notes
authored
27 are in `bin/`. You can install the apk either directly on the device or via
28 'adb install'
74aa1e0 @mathiask added HACKING.md
mathiask authored
29
30 Eclipse Setup
31 -------------
32 I imported the following projects using
33 "File > Import > Existing Android Code Into Workspace"
34 and selecting the project root directory:
35 * com.matburt.mobileorg.Gui.OutlineActivity
36 * com.twofortyfouram.locale.MarketActivity
37 * library
38
39 Note: To also import `test` you have to include other projects, as well.
40 But I haven't tried that out, yet.
41
42 Deployment
43 ----------
44 * Uninstall the current mobileorg-android from your device.
45 * Probably renaming the application package also works.
46 * Run `com.matburt.mobileorg.Gui.OutlineActivity` as "Android application".
47
67228bf @matburt More HACKING notes
authored
48 Notes regarding pull requests
49 -----------------------------
50 Make sure that any changes or additions that you make will also build from the
51 command line. This is a requirement before changes will be accepted into the
52 mainline branch.
53
54 Notes regarding dropbox.xml
55 ---------------------------
56 The private keys used to access Dropbox accounts for users are not included.
57 That's not entirely true. The file exists but contains dummy values so if you want
58 dropbox to work on your local builds then you will need to request your own keys from
59 Dropbox.
74aa1e0 @mathiask added HACKING.md
mathiask authored
60 Happy hacking!
Something went wrong with that request. Please try again.