- cleaned up how build.xml makes distribution packages

- cleaned up externals
- updated README
- created new README for minimized package
- updated timeline-api.js docs to reflect changes


git-svn-id: http://simile-widgets.googlecode.com/svn/timeline/trunk@1942 579c892a-5248-0410-a714-2bcf037eb5bf

MIN_README.txt

@@ -0,0 +1,77 @@
+
+
+
+                                T I M E L I N E
+                                ---------------
+
+
+  What is this?
+  -------------
+
+  Timeline is a web widget for visualizing temporal data.
+
+
+  Installing Timeline
+  -------------------
+
+  Timeline consists entirely of static files (javascript libraries,
+  image files and css files). All you really need is to
+  serve the files contained in this package off a web server without 
+  having to install any special server side functionality: the software
+  is all executed in the browser.
+
+  So, simply copy the files contained in this package to a location
+  that is served by your web browser, making sure to keep the files
+  in the same folder structure and you're done.
+
+
+  How do I use Timeline?
+  ----------------------
+
+  For the impatient, read the comments inside "timeline-api.js" that will
+  get you started.
+
+  If you want to know more, refer to the Timeline documentation at 
+
+    http://www.simile-widgets.org/timeline/
+
+
+  Mailing List and Forum
+  ----------------------
+
+  Join the community by joining the Google Group SIMILE Widgets
+
+    http://groups.google.com/group/simile-widgets/
+
+
+  Licensing and legal issues
+  --------------------------
+
+  Timeline is open source software and are licensed under the BSD license
+  located in the LICENSE.txt file located in the same directory as this very file
+  you are reading.
+
+
+
+  Credits
+  -------
+
+  This software was created by the SIMILE project and originally written
+  by the SIMILE development team (in alphabetical order):
+
+   - David Fran�ois Huynh <dfhuynh at csail.mit.edu>
+
+
+
+
+                                --- o ---
+
+
+  Thanks for your interest.
+
+
+
+
+                                                        The SIMILE Widgets Project
+                                                      http://www.simile-widgets.org/
+

README.txt

@@ -1,58 +1,65 @@
 
-                                T I M E L I N E
 
 
+                                T I M E L I N E
+                                ---------------
+
+
   What is this?
   -------------
 
-  Timeline is a DHTML-based AJAXy timeline.
+  Timeline is a web widget for visualizing temporal data.
 
 
   Running Timeline
   ----------------
 
-  Timeline consists of static resources, Javascript libraries,
-  image files and css files. All you really need is to
-  serve those resources off a web server. Any web server will do.
+  Timeline consists entirely of static files (javascript libraries,
+  image files and css files). All you really need is to
+  serve those resources off a web server without having to install
+  any special server side functionality. Therefore any web server will do.
 
-  Two ways to access the library
+  Two ways to access the library:
 
-  1. Unzip either timeline_source.zip or timeline_libraries.zip into
-     a directory served by a webserver.
-
-     timeline_source.zip includes complete source and example files. Use your
-     browser to see the examples at
-     .../timeline_directory/src/webapp
-
-     timeline_libraries.zip is the minimum install of the bundled js libraries,
-     css and image files
+  1. If you have a web server running your machine:
+
+     a) install the Java runtime from Sun if your OS doesn't have it already
+        (get it for free at http://www.java.com)
+     b) install Apache Ant (get it for free at http://ant.apache.org)
+     c) Open a shell or command prompt in the same directory of this file and type:
+
+      > ant
+
+     Ant will use the 'build.xml' configuration file to construct and the script will copy all the required files in the give path.
 
-  2. No web server? The timeline project includes a small webserver called
-     Jetty (use the timeline_source.zip file)
-     a) install the Java runtime from Sun
-     b) unzip timeline_source.zip to an install directory
-     c) Open a shell or command prompt to the install directory and type:
+  2. No web server? The timeline project includes a small webserver to get you started:
 
-     [win32]> run
-     [unix/macosx]> chmod +x run; ./run
+     a) install the Java runtime from Sun if your OS doesn't have it already
+        (get it for free at http://www.java.com)
+     b) Open a shell or command prompt in the same directory of this file and type:
+
+      [win32]> run
+      [unix/macosx]> ./run
 
      and then point your browser to
 
-     http://127.0.0.1:9999/timeline/
-
+      http://127.0.0.1:9999/timeline/
 
+
   How do I customize Timeline?
   ----------------------------
 
   Refer to the Timeline web site at 
-  http://code.google.com/p/simile-widgets/
+
+    http://www.simile-widgets.org/timeline/
 
 
   Mailing List and Forum
   ----------------------
 
   Join the community by joining the Google Group SIMILE Widgets
-  http://groups.google.com/group/simile-widgets/
+
+    http://groups.google.com/group/simile-widgets/
 
 
   Licensing and legal issues
@@ -83,6 +90,6 @@
 
 
 
-                                                        The SIMILE Project
-                                                      http://simile.mit.edu/
+                                                        The SIMILE Widgets Project
+                                                      http://www.simile-widgets.org/