root/other-projects/tipple-android/README.txt @ 26900

Revision 26900, 5.1 KB (checked in by davidb, 7 years ago)

Fixed minor typos in README.txt

Line 
1TIPPLE README
2-------------
3
41.  SVN checkout this URL to somewhere (from now on I will call this "somewhere" the "root" dir):
5    http://svn.greenstone.org/other-projects/tipple-android/
6   
7    The layout of the folder you checked out is as follows:
8          tipple-lib (main Tipple library)
9      tipple-standalone (main implementation of Tipple that references tipple-lib)
10      osmosis (plugin to create your own 2D map files for Tipple, see PDF file "mapsforge-getting-started.pdf" inside this folder)
11      mixare-fixes (optional fixes for Mixare)
12      i-greenstone-server-files (things for i-greenstone-server)
13
142.  Assuming you have at least Android 2.3.3 SDK installed, import into Eclipse the folders
15    tipple-lib, tipple-standalone
16   
173.  Edit setup.sh if necessary in order to put the Android SDK "platform-tools" folder
18    on the classpath, then type into cygwin terminal:
19   
20    source setup.sh
21
224.  Unzip/untar "mixare-development" into the same directory as mixare-fixes.sh, and
23    rename it to "mixare".
24
25    (Latest repo of Mixare is probably here, in case you do want to work with the latest version:
26    https://github.com/DevBinnooh/mixare)
27   
285.  In the root directory of trunk, execute this .sh script in your cygwin terminal by typing:
29   
30    ./mixare-fixes.sh
31
326.  Launch Eclipse, and import:
33    mixare      (this requires you to select "mixare/" in the import projects window)
34    mixare-lib  (this requires you to select "mixare/plugins" in the import projects window)
35   
36    (If Eclipse complains about one of these projects not having a "res" folder, just create
37    a blank folder called "res" for the project in Eclipse)
38   
39    Within Eclipse, run as "Android Application" the mixare project (not mixare-lib).
40    This will install it onto your phone. Now with that done, the only thing left
41    to do is run as "Android Application" the project:
42
43
447.  Type into cygwin terminal (with Android device connected with USB):
45
46    adb install i-greenstone-server-files/i-jetty-3.1-aligned.apk
47   
48    This will install i-greenstone-server on your phone. Then launch the
49    application at least once and wait for it to set itself up.
50   
51    Then do:
52   
53    adb push i-greenstone-server-files/greenstone/webapps/greenstone3/sites/localsite/collect/tipple-universe /sdcard/greenstone/webapps/greenstone3/sites/localsite/collect/tipple-universe
54
55    (For the sake of being conservative, I have given you my own development files to push over. If you want to
56    start from scratch and compile your own i-greenstone-server and generate your own "latest and greatest" GS3
57    webapp on it, then I suggest you check out on the Greenstone SVN the extensions "i-greenstone-server" and
58    "android-war", found in the folder "gs3-extensions".)
59   
608.  Open i-greenstone-server, and click "Start Greenstone".
61   
629.  In Eclipse, run "Tipple" (not "Tipple Library") as an Android application, and hopefully everything works out!
63
64    (You will see one marker on campus with the i-greenstone-server turned on, and you'll see six markers with the pre-built hamilton.loc XML file.
65    If you change your GPS location to Whangarei (i.e. with a fake GPS application) you should see more!)
66   
67    If not, immediately shoot me an email at cjb60@students.waikato.ac.nz. Do not hesitate!
68   
69   
70ADDITIONAL INFORMATION
71----------------------
72
73- I have included a folder with the Tipple SVN called "osmosis", if you are
74interested in building your own .map file for Tipple. Because I had issues
75with the latest version of Osmosis, I put on SVN the version of Osmosis
76I used + a saved version of the "getting started" webpage as a PDF. You only
77really need to use the "getting started" PDF in order to find out how to install
78the Mapsforge plugin for Osmosis. Once you have the Mapsforge plugin installed, go to osmosis/bin
79and look at the example compile.bat I have created in order to generate your
80own .map file.
81   
82- Even if the GPS is turned on and you turn on AR View (Mixare) in Tipple, it may
83say something like "Connection error occured - please make sure you are connected
84to internet" or something like that. You just have to keep hitting "Retry" until it
85works (it will disappear when Mixare gets a GPS location fix).
86
87- When you query from i-greenstone-server, all "locations" have the same marker radius, which is
88actually quite big. This is because originally my articles in the collection "tipple-universe"
89did not have the "Radius" metadata in them. So if you put a "Radius" metadata in an article,
90my GreenstoneXMLRetriever.java should map that to "radius", as long as you remove
91the exact line I used to hardcode the radius.
92
93BUGS
94----
95
96- i-greenstone-server may randomly stop hosting sometimes. Logcat logs indicate
97the OS is trying to get rid of it. Or maybe it's a problem I caused. Definitely look into this.
98
99- Whenever Tipple removes all the markers and displays new ones (i.e. when your location has
100changed sufficiently), if you go into one of the new locations and the phone vibrates, you
101won't see the yellow marker with the '+' symbol telling you you're currently in this location.
102
103-------
104CONTACT
105-------
106
107If you are confused about any of this or want more info, do not hesitate to email me at:
108cjb60@students.waikato.ac.nz
Note: See TracBrowser for help on using the browser.