[Roxygen-commits] r15 - pkg

[noreply at r-forge.r-project.org]

Author: pcd
Date: 2008-06-02 15:51:10 +0200 (Mon, 02 Jun 2008)
New Revision: 15

Modified:
   pkg/README
Log:
verbose README


Modified: pkg/README
===================================================================
--- pkg/README	2008-06-02 13:51:08 UTC (rev 14)
+++ pkg/README	2008-06-02 13:51:10 UTC (rev 15)
@@ -1,5 +1,15 @@
 all' hileth', Hephaiste; didou d'areten te kai olbon.*
 --Homer, 7 BCE
 
+The driver, `main.R', parses `example.R', the example file given by
+Manuel in the original GSoC idea-paper.
+
+Upon execution, one should see a parse-tree of parsed elements
+(represented as lists); accompanied by a srcref of the apposite
+object.
+
+The srcref can be processed for gleaning further information (S4
+class, object name, &c).
+
 -----------
 * Hail, Hephaistos! Grant skill and weal.