This application is a soundscape map of the UO campus for the blind or people with limited vision. It's Java-based and primarily for
experimental use by researchers and testers. However it does include many user-friendly features and can be easily turned into an application
for end-users.

The map is generated on the fly. This application can be modified to make other maps. For details, see docs/tech.htm.



Overview:



I. System Requirements

II. Running the Application (no installation needed)

III. Building the Application - UPDATED(2008-10-25)

IV. User Manual and Technical Documentation

V. Programmers - UPDATED





I. System Requirements

CPU: Intel Pentium III (or better)     

RAM: 128MB

Disk Space: 42MB free storage space

Operating System: Windows XP (Could work on other Windows versions)
		  Linux (has only been tested on Ubuntu 7.10)
		  Mac OS X is not supported at the moment

Software: JRE 5 or higher
    
Accessories: Speaker(s)

Optional: Mouse
	  Screen-Reader
 

II. Running the Application (no installation needed)

To run the application on Windows, do one of the following, (listed from most common to less common):

1. Double-click UOMap.exe in root directory.
2. If the above somehow didn't work, double-clicking UOMap.jar could work if the .jar file type is associated with the JRE.
3. In a command line (start menu - run - type in "cmd" and hit ok), enter the root directory (UOMap), and type "java -jar UOMap.jar" and hit enter.

On Linux:
GUI: Double-click run.sh in root directory.
Command line: cd into root directory, type "./run.sh".

On both Windows and Linux (Programmer-oriented) Load the project in Eclipse. Build (automatically by default) and run it.

You'll see the map if it runs. :)


III. Building the Application

1. In Eclipse during development:

We recommend using Eclipse for development. Our project is structured with Eclipse as our development tool, and it's easy to get started modifying the source in it.

By default, Eclipse builds the application as .class files when you import the project, and every time you save some changes. The compilation is incremental,
so you almost don't notice it for small changes.

% UPDATE 2008-10-25 %

2. In NetBeans development environment:
In the "Projects" window, locate the "Libraries" folder, right-click and select
"Properties...". In that window, find the "Library folders section..." and 
select "Browse...". Then use the default location of .\lib and follow the rest
of the dialog screens. This will ensure that all libraries in the \lib folder
are recognized by NetBeans.

3. In non-Eclipse development environments or when building it to distribute:

As a requirement, you need to have Apache Ant installed. 

First, make sure you have ANT installed. NetBeans comes with ANT 
pre-installed. Eclipse has an ANT plugin available.

You will also have to copy java-cup-11a-runtime.jar from the lib
directory to the Apache Ant lib directory. We added the parser
functionality to directly to the src structure to allow
Keith Albin's stylesheet to work. Ant needs the .jar file to build
program correctly with the update.

You can also call ant -lib and point to the project's lib folder
this can be done in Windows and Linux. So you will need to edit
build.bat or build.sh to add the lib option.

% END UPDATE 2008-10-25 % 

Then,

On Windows:
1. Double-click build.bat in root directory. This produces UOMap.jar, but not the exe. This is good enough for more advanced users. See II.
2. (Optional, this produces the exe) Get JSmooth and install (http://jsmooth.sourceforge.net), which we used to produce the exe. It's GPL and easy to use (full GUI, no hand editing
configuration files). Make sure you do step 1 first, then double-click exe_build.jsmooth in the map root directory. (Alternatively, run JSmooth, System - Open, and select this file.)
You can change the exe attributes, program/JVM parameters, and classpaths (if you have added new libraries). Then, Project - Compile will make the exe.

On Linux:
GUI: Double-click build.sh in root directory.
Command line: cd into root directory, type "./build.sh".


IV. User Manual and Technical Documentation

For information on how to use the application, see docs/man.htm.
For information on the system architecture, design, and technical details, see docs/tech.htm.


V. Programmers

This application was produced by the Red Team in CIS 422 07F. Professor: Michal Young (michal@cs.uoregon.edu). 
Members: Josh Caba (jcaba@cs.uoregon.edu), Roger Cerkas(rcerkas@cs.uoregon.edu), Duheng Deng(ddh33@cs.uoregon.edu), James Erickson(jerickso@uoregon.edu), Jonathan Woo(jwred5@cs.uoregon.edu). 

This application was updated by the Ramani Map Team in CIS 422 08F. Professor: Michal Young (michal@cs.uoregon.edu).
http://www.assembla.com/wiki/show/ramani
Members: 
Jeremy Blanchard (jblancha@uoregon.edu), 
Michael Dalby (mdalby@uoregon.edu), 
Tai Horgan (thorgan@uoregon.edu), 
Daniel Mundra (dmundra@uoregon.edu), 
Slavko Pesic (spesic@uoregon.edu).