~dhis-mobile-devs/dhis-mobile/2.8

6 by Saptarshi
Added README for developer guide
1
DEVELOPER README
2
****************
3
4
DHIS Mobile is a free and open-source software for low-end Java phones.
5
It is an extensible application that communicates with the popular HMIS
6
application called DHIS2. It is a JavaME application that downloads forms
7
from DHIS2 or Community DHIS into the mobile phone and displays 
8
datasets or program stages on which a health worker can enter data and 
9
sends to the online server.
10
11
DHIS Mobile Developers are spread across the world and are located around 
12
the world. The project is maintained at: https://launchpad.net/dhis-mobile
13
14
Here is some introductory info to get you started:
15
16
Initial reading
17
===============
18
19
The source-code is stored in the launchpad Bazaar repository and bugs/features
20
are tracked at the launchpad project site. The primary discussion around the
21
project happens at the developers mailing lists and joining the project at
22
launchpad is the best way to get started.
23
24
A related research project which is associated with the application and its
25
design, development, implementation and evaluation is through the MobiHealth
26
project at the University of Oslo: http://www.hisp.uio.no/projects/mobihealth/
27
28
Building from source-code
29
=========================
30
31
Developers should start by downloading the source-code using the Bazaar distributed
32
version control system <http://bazaar.canonical.com/en/>. After installing bazaar,
33
the source code can be downloaded anonymously using command $> bzr branch lp:dhis-mobile
34
35
Extract the project-files.zip into the same folder. These are required files for opening
36
the project through Eclipse and allow easy importing the project to Eclipse workspace 
37
38
The mobile application is developed using the MTJ Eclipse plugin. Thus, Eclipse needs to
39
be downloaded and installed. After installing eclipse, MTJ needs to be installed using
40
instructions located here: http://live.eclipse.org/node/614
41
42
You would also like to install different JavaME emulators (e.g. WTK 2.5.2) to be able to
43
emulate and view the application instead of having to copy the application to a mobile 
44
phone.
45
46
After installing the MTJ plugin, start/restart Eclipse and in the menu File->Import, 
47
General -> Existing projects into workspace, then Next and Browse to the DHISMobile folder
48
in the downloaded source.
49
 
50
How can you help?
51
=================
52
53
   * Check the bug list at the DHIS Mobile Launchpad project,
54
     or subscribe to the mailing list and discuss the project.
55
     If you can volunteer for blueprints or bugs at the projects, 
56
     or if you have any useful comments send email!
57
58
   * Give us feedback!  Tell us what you like; tell us what you think
59
     could be better.
60
61
DHIS2 Mobile Developers
62
<mobile-devs@hisp.uio.no>