*** Everything here is Copyright 2008 Citizen Logistics, LLC ***
***         and released under the Affero GPL v3             ***



==============================================
== Running the viewer on your local machine ==
==============================================

Run the following in a shell, to build the javascipt and html up
for constituent files, and then to grab real live data to test
with from the real groundcrew.us server and cache it locally.

% make
% make grab GCUN='<your groundcrew.us email>' GCPW='<your password>'

At this point you should be able to run the viewer locally in
firefox or safari or whatever:

% open BUILD/viewer.html     # or...
% firefox BUILD/viewer.html

If you change javascript, html or css files, you have to run
'make' to rebuild.

The only thing that doesn't work quite right in local mode are
the user images.  Sorry about that.  Also, only your home city
will have data loaded from the server.



=====================
== Troubleshooting ==
=====================

GOOGLE MAPS:  In order for google maps to work, you need to access 
the viewer from either a *.groundcrew.us domain, or a localhost url, 
or a file:/// url.  If you refer to your local machine in some other 
way it will not work.



===========================
== Navigating the source ==
===========================

Here are the directories we use:

/app/
   app.html.m4    - the basic HTML layout for the app
   app.js         - general UI initialization for the app
   chrome/        - html/css/js for the viewer's basic UI
   helpers/       - js/css for reusable widgets used across modes
   maplayers/     - js for generating markers for agents, landmarks, etc
   modes/         - plugins that handle certain tasks, like welcoming, organizing, etc

/lib/
  jsappkit/       - underlying app framework
  jsmapkit/       - extensions to jsappkit for handling the map and markers
  gc_api/         - javascript utilities for groundcrew domain objects (agents, landmarks, etc)

/BUILD/           - target directory of the make process
/css/             - cascading style sheets for non-apps
/i/               - images
/vendor/          - javascript from outside sources
/tests/           - qunit javascript tests




============================
== In-depth documentation ==
============================

More in-depth documentation can be found in the directory docs/.



=============
== Contact ==
=============

Contact us via the viewer's developer mailing list:

http://groups.google.com/group/groundcrew-viewer-developers