checkpoint

[sbp.git] / src / edu / berkeley / sbp / package.html
diff --git a/src/edu/berkeley/sbp/package.html b/src/edu/berkeley/sbp/package.html

index b712dd9..bcba1d8 100644 (file)
--- a/src/edu/berkeley/sbp/package.html
+++ b/src/edu/berkeley/sbp/package.html
@@ -1,3 +1,31 @@
  <body>
  <body>
-<b><font color=red>IMPORTANT:</font> BE SURE TO READ THE FILE <tt><font size=big><a href=../../../../jargon.txt>doc/jargon.txt</a></big></tt> FIRST!</b>
+<p>
+<b>
+  <font color=red>IMPORTANT:</font>
+     BE SURE TO READ THE FILE
+     <tt><font size=big><a href=../../../../jargon.txt>doc/jargon.txt</a></big></tt> FIRST!<br> Also, see the legend at the bottom of this page.
+</b>
+</p>
+
+<p>
+This package forms the stable core of the SBP API  Classes fall into
+five categories:
+
+<ul> <li> <font color=green>Elements of the grammar</font> -- the
+          pieces from which a grammar is composed.
+
+     <li> <font color=purple>Input, Location, and Region</font> -- the
+          input to be parsed, as well as classes for describing
+          locations and regions of that input.
+
+     <li> Parser -- the engine that actually performs the parsing
+          process.
+
+     <li> <font color=blue>Trees and Forests</font> -- used to
+          represent the output of the parsing process.
+
+     <li> Exceptions.
+</ul>
+</p>
+          
  </body>
  </body>