[Assorted-commits] SF.net SVN: assorted: [636] scala-doc-search/trunk/README

[<yan...@us...>]

Revision: 636
          http://assorted.svn.sourceforge.net/assorted/?rev=636&view=rev
Author:   yangzhang
Date:     2008-03-19 09:39:11 -0700 (Wed, 19 Mar 2008)

Log Message:
-----------
made readme more useful

Modified Paths:
--------------
    scala-doc-search/trunk/README

Modified: scala-doc-search/trunk/README
===================================================================
--- scala-doc-search/trunk/README	2008-03-19 16:38:42 UTC (rev 635)
+++ scala-doc-search/trunk/README	2008-03-19 16:39:11 UTC (rev 636)
@@ -1,3 +1,17 @@
-1. ./index.bash
-2. Upload srch.hs, index.php, and scaladocs.txt; ensure they're in the same dir
-3. Browse to index.php
+Overview
+--------
+
+Search scaladoc-generated documentation by class/object/trait name.
+
+This [service] is running for the main Scala API.  The code provided here can
+be used to search any scaladoc-generated documentation (e.g., if you want to
+search your own API).
+
+[service]: http://scripts.mit.edu/~y_z/sds/
+
+Setup
+-----
+
+1. Run `mkindex.bash` to generate the lookup index `scaladocs.txt`.
+2. Upload `srch.hs`, `index.php`, and `scaladocs.txt`; ensure they're in the same dir.
+3. Browse to that dir (`index.php`).


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.