[lucy-commits] svn commit: r1133215 - /incubator/lucy/trunk/example-lang/README

[ma...@apache.org]

Author: marvin
Date: Wed Jun  8 00:17:10 2011
New Revision: 1133215

URL: http://svn.apache.org/viewvc?rev=1133215&view=rev
Log:
Update example-lang/README.

Modified:
    incubator/lucy/trunk/example-lang/README

Modified: incubator/lucy/trunk/example-lang/README
URL: http://svn.apache.org/viewvc/incubator/lucy/trunk/example-lang/README?rev=1133215&r1=1133214&r2=1133215&view=diff
==============================================================================
--- incubator/lucy/trunk/example-lang/README (original)
+++ incubator/lucy/trunk/example-lang/README Wed Jun  8 00:17:10 2011
@@ -4,10 +4,32 @@ overview of Lucy's layers:
 
     http://incubator.apache.org/lucy/docs/perl/Lucy/Docs/DevGuide.html
 
-The C files within "example-lang/src" contain stubs for C functions whose
-interfaces are defined within "trunk/core".  These functions fill in the
-missing pieces of the puzzle.  Once they are all implemented correctly, Lucy
-will theoretically build and pass its tests.
+To get started, copy "example-lang" to a directory named after the language
+you'd like to bind to:
+
+    cp -R example-lang xyz
+
+Most of the C files within the "example-lang/src" directory contain stubs for
+routines whose interfaces are defined within "trunk/core".  
+
+    core/src/Lucy/Index/Inverter.cfh        # Declares interface.
+    core/src/Lucy/Index/Inverter.c          # all except Invert_Doc()
+    example-lang/src/Lucy/Index/Inverter.c  # only Invert_Doc() 
+
+Once all the stubs have been implemented correctly, Lucy will theoretically
+build and pass its tests.
+
+There is one pair of files with an interface *not* defined in core.
+
+    example-lang/src/CFBind.h
+    example-lang/src/CFBind.c
+
+The CFBind files are there to hold conversion routines which are specific to a
+language binding.  Since it is impractical to impose a generic interface, they
+are not defined in core.
+
+You may wish to start by referencing a finished language binding to get a feel
+for what should go in the CFBind files.
 
 Some of Lucy's classes really ought to be grouped with Clownfish, as they form
 something similar to a free floating "standard library" and are not