DPML Notify

[mcconnell AT netcompartner.com]

Author: mcconnell
Date: Sat Jan 29 13:54:43 2005
New Revision: 1623

Added:
   development/main/transit/README.TXT
Log:
add the README

Added: development/main/transit/README.TXT
==============================================================================
--- (empty file)
+++ development/main/transit/README.TXT Sat Jan 29 13:54:43 2005
@@ -0,0 +1,64 @@
+
+Product: Transit
+Description: Resource Management Framework
+Publisher: The Digital Product Meta Library
+Revision: @PRODUCT-VERSION@
+
+Installation Instructions
+=========================
+
+Contents of the distribution
+----------------------------
+
+  /dpml-transit-@PRODUCT-VERSION@
+    /bin ............................. cli scripts for the transit system
+    /docs ............................ javadoc for util and transit modules
+    /local ........................... jar and module files
+    /transit ......................... transit configuration files
+
+Creating the installation:
+
+  1. create your DPML home directory - instructions are provided
+     at the following url (don't forget to include the 
+     DPML home bin directory in you PATH environment variable)
+     http://www.dpml.net/guide/setup/dpml.html
+
+  2. copy the contents directory dpml-transit-@PRODUCT-VERSION@ into 
+     your DPML home directory.
+
+  You should now have a directory structure that looks like the following;
+
+    /[DPML-HOME-DIR]
+      /bin
+      /docs
+      /local
+      /transit
+
+  If you have declared a DPML_HOME environment variable then the 
[DPML-HOME-DIR] 
+  should correspond to this.  If you have not created an DPML_HOME variable 
then
+  the [DPML-HOME-DIR] should be the equivalent of ${user.home}\.dpml.
+
+Verifying the installation
+--------------------------
+
+  The following command verifies that the Transit system is correctly 
installed.
+  From a new console windw, execute the following command:
+
+    $ transit -Xversion
+
+  You should see output similar to the following:
+
+    Transit: 
artifact:plugin:dpml/transit/dpml-transit-plugin#@PRODUCT-VERSION@
+    Build: 20050129.042138
+
+Transit Documentation
+---------------------
+
+Reference documentation and user guides are available under the DPML Home.
+
+  Transit Product Documentation
+  http://www.dpml.net/products/transit
+
+  Transit User's Guide
+  http://www.dpml.net/guide/transit
+