hps-java/src/main/java/org/lcsim/hps/conditions

diff -u -r1.1 -r1.2
--- package-info.java	19 Mar 2012 20:58:11 -0000	1.1
+++ package-info.java	26 Mar 2012 21:01:50 -0000	1.2
@@ -1,5 +1,18 @@

 /**

- * Classes adding HPS-specific functionality to the <tt>org.lcsim</tt> conditions framework. 

+ * Classes adding HPS-specific functionality to the <tt>org.lcsim</tt> conditions framework.
+ * <p>
+ * This is a demo implementation of the package. The goal was to minimize changes 
+ * to the <tt>org.lcsim.conditions</tt> package required to support HPS extensions, and
+ * to guarantee backward compatibility.
+ * <p>
+ * To enable reading conditions from the HPS database:
+ * <ul>
+ * <li>Add the line "ConditionsReader: org.lcsim.hps.conditions.HPSConditionsReader" to
+ *     the <tt>detector.properties</tt> file in your conditions ZIP file or directory.</li>
+ * <li>Install MySQL driver into your classpath.</li>
+ * </ul>
+ * Once the exact structure of the database and the calibration data to be retrieved is
+ * known, more efficient and robust implementation will be coded.

  * 
  * @see org.lcsim.conditions
  */