|
1 | 1 | # Introduction |
2 | 2 |
|
3 | 3 | Gnucash Mobile for Android is companion application for desktop Gnucash designed for Android. |
4 | | -It allows you to record transactions on-the-go and export them in the OFX format and later import the data into Gnucash for the desktop. You can create multiple accounts for transactions in Gnucash. Double-entry accounting is also supported. |
| 4 | +It allows you to record transactions on-the-go and export them in the QIF or OFX format and later import the data into Gnucash for the desktop. You can create multiple accounts for transactions in Gnucash. Double-entry accounting is also supported. |
5 | 5 |
|
6 | 6 | The application supports Android 2.2 Froyo (API level 8) and above. |
7 | 7 |
|
8 | 8 |
|
9 | 9 | # Installation |
10 | 10 |
|
11 | | -There are different ways to get the Gnucash app for Android; through the app store, or building it yourself. |
| 11 | +There are different ways to get the Gnucash app for Android; through the app store, or building it yourself. |
12 | 12 |
|
13 | 13 |
|
14 | | -### App Store |
| 14 | +### App Store |
15 | 15 |
|
16 | 16 | <a href="http://play.google.com/store/apps/details?id=org.gnucash.android"> |
17 | 17 | <img alt="Android app on Google Play" src="http://developer.android.com/images/brand/en_generic_rgb_wo_60.png" /> |
18 | | -</a> |
19 | | - |
20 | | - |
21 | | -## Building |
22 | | - |
23 | | -The build requires [Maven](http://maven.apache.org/download.html) |
24 | | -v3.0.3+ and the [Android SDK](http://developer.android.com/sdk/index.html) |
25 | | -to be installed in your development environment. In addition you'll need to set |
26 | | -the `ANDROID_HOME` environment variable to the location of your SDK: |
27 | | - |
28 | | - export ANDROID_HOME=/home/roberto/tools/android-sdk |
29 | | - |
30 | | -After satisfying those requirements, the build is pretty simple: |
31 | | - |
32 | | -* Run `mvn clean package` from the `app` directory to build the APK only |
33 | | -* Run `mvn clean install` from the root directory to build the app and also run |
34 | | - the integration tests, this requires a connected Android device or running |
35 | | - emulator. (see this [blog post](http://goo.gl/TprMw) for details) |
36 | | - |
37 | | -You might find that your device doesn't let you install your build if you |
38 | | -already have the version from the Android Market installed. This is standard |
39 | | -Android security as it it won't let you directly replace an app that's been |
40 | | -signed with a different key. Manually uninstall GnuCash from your device and |
| 18 | +</a> |
| 19 | + |
| 20 | + |
| 21 | +## Building |
| 22 | + |
| 23 | +The build requires [Maven](http://maven.apache.org/download.html) |
| 24 | +v3.0.3+ and the [Android SDK](http://developer.android.com/sdk/index.html) |
| 25 | +to be installed in your development environment. In addition you'll need to set |
| 26 | +the `ANDROID_HOME` environment variable to the location of your SDK: |
| 27 | + |
| 28 | + export ANDROID_HOME=/home/<user>/tools/android-sdk |
| 29 | + |
| 30 | +After satisfying those requirements, the build is pretty simple: |
| 31 | + |
| 32 | +* Run `mvn clean package` from the `app` directory to build the APK only |
| 33 | +* Run `mvn clean install` from the root directory to build the app and also run |
| 34 | + the integration tests, this requires a connected Android device or running |
| 35 | + emulator. (see this [blog post](http://goo.gl/TprMw) for details) |
| 36 | + |
| 37 | +You might find that your device doesn't let you install your build if you |
| 38 | +already have the version from the Android Market installed. This is standard |
| 39 | +Android security as it it won't let you directly replace an app that's been |
| 40 | +signed with a different key. Manually uninstall GnuCash from your device and |
41 | 41 | you will then be able to install your own built version. |
42 | 42 |
|
| 43 | +## Contributing |
| 44 | + |
| 45 | +There are several ways you could contribute to the development. |
| 46 | + |
| 47 | +One way is providing translations for locales which are not yet available, or improving translations. |
| 48 | +See this [blog post](http://www.codinguser.com/2012/09/gnucash-for-android-beta-2-lost-in-translation/) for some guidelines. |
| 49 | + |
| 50 | +You could as well contribute code, fixing bugs, new features or automated tests. |
| 51 | +Take a look at the [bug tracker](https://github.com/codinguser/gnucash-android/issues?state=open) |
| 52 | +for ideas where to start. |
| 53 | + |
| 54 | +For development, it is recommended to use the IntelliJ IDEA 13+ IDE for development which is available as free |
| 55 | +community edition. Import the project into the IDE from an external (maven) model.The IDE will resolve dependencies automatically. |
43 | 56 |
|
44 | 57 | #Licence |
45 | 58 | Gnucash for Android is free software; you can redistribute it and/or |
|
0 commit comments