Learn how easy it is to sync an existing GitHub or Google Code repo to a SourceForge project! See Demo

Close

Commit [bd3505] default Maximize Restore History

Renamed all README files to README.txt

Also did some fix up to doc/source/about_pyke/modifying_pyke.txt.

Passes ./testpyke, link checks and spell checks on documentation.

mtnyogi mtnyogi 2009-11-03

<< < 1 2 (Page 2 of 2)
added examples/sqlgen/testall.config
changed pyke/krb_compiler/ply/README.pyke
changed pyke/krb_compiler/kfbparser_tables.py
changed pyke/target_pkg.py
changed setup.py
copied examples/knapsack/README -> examples/knapsack/README.txt
copied examples/forall/README -> examples/forall/README.txt
copied examples/findall/README -> examples/findall/README.txt
copied examples/notany/README -> examples/notany/README.txt
copied README -> README.txt
examples/sqlgen/testall.config Diff Switch to side-by-side view
Loading...
pyke/krb_compiler/ply/README.pyke Diff Switch to side-by-side view
Loading...
pyke/krb_compiler/kfbparser_tables.py Diff Switch to side-by-side view
Loading...
pyke/target_pkg.py Diff Switch to side-by-side view
Loading...
setup.py Diff Switch to side-by-side view
Loading...
examples/knapsack/README to examples/knapsack/README.txt
--- a/examples/knapsack/README
+++ b/examples/knapsack/README.txt
@@ -25,8 +25,9 @@
 
         >>> from examples.knapsack import test
         >>> test.run((('bread',4,9200),
-                      ('pasta',2,4500),
-                      ('peanutButter',1,6700),
-                      ('babyFood',3,6900)),
-                     4)
+        ...           ('pasta',2,4500),
+        ...           ('peanutButter',1,6700),
+        ...           ('babyFood',3,6900)),
+        ...          4)
+        (13600, (('peanutButter', 1, 6700), ('babyFood', 3, 6900)))
 
examples/forall/README to examples/forall/README.txt
--- a/examples/forall/README
+++ b/examples/forall/README.txt
@@ -8,8 +8,16 @@
 These rules find all people who have no step brothers or sisters.
 
     >>> from examples.forall import test
+
+    # uses fc_forall.krb
     >>> test.fc_test()
-    ... prints out everybody that doesn't have any step brothers or sisters ...
+    arthur2 has no step brothers or sisters
+    helen has no step brothers or sisters
+    roberta has no step brothers or sisters
+
+    # uses bc_forall.krb
     >>> test.bc_test()
-    ... prints out everybody that doesn't have any step brothers or sisters ...
+    arthur2
+    helen
+    roberta
 
examples/findall/README to examples/findall/README.txt
--- a/examples/findall/README
+++ b/examples/findall/README.txt
@@ -8,8 +8,22 @@
 siblings and all cousins and assert them in a single fact (as a tuple).
 
     >>> from examples.findall import test
+
+    # uses fc_findall.krb
     >>> test.fc_test()
-    ... prints out all cousins information using fc_findall.krb ...
+    egon has ('harald', 'claudia') as cousins
+    ralf has ('harald', 'claudia') as cousins
+    hilde has () as cousins
+    diethelm has () as cousins
+    harald has ('egon', 'ralf') as cousins
+    claudia has ('egon', 'ralf') as cousins
+
+    # uses bc_findall.krb
     >>> test.bc_test()
-    ... prints out all cousins information using bc_findall.krb ...
+    egon has ('harald', 'claudia') as cousins
+    ralf has ('harald', 'claudia') as cousins
+    hilde has () as cousins
+    diethelm has () as cousins
+    harald has ('egon', 'ralf') as cousins
+    claudia has ('egon', 'ralf') as cousins
 
examples/notany/README to examples/notany/README.txt
--- a/examples/notany/README
+++ b/examples/notany/README.txt
@@ -8,8 +8,30 @@
 These rules find all people who have no aunts all people with no uncles.
 
     >>> from examples.notany import test
+
+    # uses fc_notany.krb
     >>> test.fc_test()
-    ... prints out everybody that doesn't have any step brothers or sisters ...
+    egon has no uncle
+    ralf has no uncle
+    anton has no uncle
+    elisabeth has no uncle
+    karin has no uncle
+    sabine has no uncle
+    anton has no aunt
+    elisabeth has no aunt
+    karin has no aunt
+    sabine has no aunt
+
+    # uses bc_notany.krb
     >>> test.bc_test()
-    ... prints out everybody that doesn't have any step brothers or sisters ...
+    anton has no aunt
+    elisabeth has no aunt
+    karin has no aunt
+    sabine has no aunt
+    egon has no uncle
+    ralf has no uncle
+    anton has no uncle
+    elisabeth has no uncle
+    karin has no uncle
+    sabine has no uncle
 
README to README.txt
--- a/README
+++ b/README.txt
@@ -20,8 +20,6 @@
 
 A copy of the html documentation is also included in the "doc/html" directory
 within the source distribution.
-
-See the end of this file for how to regenerate the html files.
 
 
 REQUIREMENTS:
@@ -50,6 +48,8 @@
     3. Run "python setup.py build"
     4. As administrator, run: "python setup.py install"
 
+See http://pyke.sourceforge.net/about_pyke/installing_pyke.html for more
+information.
 
 SOURCE DISTRIBUTION:
 
@@ -59,7 +59,7 @@
 EXAMPLES:
 
 Each example is in a separate subdirectory under the "examples" directory.
-Each example has a README file that explains how to run it.
+Each example has a README.txt file that explains how to run it.
 
 The family_relations example is a good place to start.  It shows several
 solutions to the same problem.  It also has an example of a few rule
@@ -75,15 +75,15 @@
 
 The web_framework example uses the sqlgen example.  This demonstrates the use
 of multiple rule bases.  The web_framework is a WSGI application that uses the
-HTMLTemplate package (install this with "sudo easy_install HTMLTemplate", be
-sure to get version 1.5 or later).  It gets the column names from the
-HTMLTemplate and feeds those to the sqlgen example to generate a plan to
-retrieve the data.  It then builds a plan to populate the template and return
-the finished HTML document.  It also caches the plans so that they don't have
-to be re-generated for each request.  This makes it run a full 10 times faster
-than the same example done in TurboGears 2!  The example includes a wsgiref
-simple_server setup to run it as an http server so that you can access it
-through your browser.
+HTMLTemplate package (install this as administrator with
+"easy_install HTMLTemplate" -- be sure to get version 1.5 or later).  It gets
+the column names from the HTMLTemplate and feeds those to the sqlgen example
+to generate a plan to retrieve the data.  It then builds a plan to populate
+the template and return the finished HTML document.  It also caches the plans
+so that they don't have to be re-generated for each request.  This makes it
+run a full 10 times faster than the same example done in TurboGears 2!  The
+example includes a wsgiref simple_server setup to run it as an http server
+so that you can access it through your browser.
 
 The learn_pyke example is an incomplete attempt at a computer based training
 program.  It only deals with the topic of pattern matching.  It is left here
@@ -92,6 +92,7 @@
 The findall, forall, knapsack, notany and towers_of_hanoi examples are each
 very small.
 
+See http://pyke.sourceforge.net/examples.html for more information.
 
 
 RUNNING DOCTESTS:
@@ -111,71 +112,8 @@
     $ ./testpyke
 
 
-WORKING WITH THE SOURCE CODE REPOSITORY:
+WORKING ON PYKE:
 
-If you want to run Python3.1, read this:
+See http://pyke.sourceforge.net/about_pyke/modifying_pyke.html for information
+about doing development work on Pyke.  Contributions of any kind are welcome!
 
-    http://pyke.hg.sourceforge.net/hgweb/pyke/pre_2to3/file/8788b112f5f6/README-3.x
-
-COMPILING kfbparser_tables.py, krbparser_tables.py and scanner_tables.py:
-
-    $ python
-    >>> from pyke.krb_compiler import kfbparser, krbparser, scanner
-    >>> scanner.init(scanner, 0, True)
-    >>> krbparser.init(krbparser, True)
-    >>> kfbparser.init(kfbparser, True)
-
-    or just run the "testall" program from the doctest-tools package:
-
-    $ cd pyke/krb_compiler
-    $ testall
-
-
-COMPILING THE COMPILER.KRB FILE:
-
-In pyke/krb_compiler:
-
-    $ PYTHONPATH=../.. python
-    >>> from pyke import krb_compiler
-    >>> krb_compiler.compile_krb('compiler', 'compiled_krb', 'compiled_krb', 'compiler.krb')
-    $ mv compiled_krb/compiler_bc.py .
-
-COMPILING THE DOCUMENTATION:
-
-To compile the documentation into html, you'll need docutils and rest2web.
-If you're running linux, your distro may have packages for these already.
-Or you can:
-
-    $ sudo easy_install rest2web
-
-I used version 0.4.1 of docutils and 0.5.0 of rest2web.  I don't know if
-earlier versions work OK or not.
-
-To check your versions:
-
-    $ python
-    >>> import docutils
-    >>> docutils.__version__
-    >>> import rest2web
-    >>> rest2web.__version__
-
-If your linux distro doesn't have packages for these, and you don't want to
-use easy_install, you can get them at:
-
-    http://sourceforge.net/projects/docutils
-    http://sourceforge.net/projects/rest2web
-
-To regenerate the html:
-
-    $ cd doc/source
-    $ bin/gen_html
-
-This regenerates everything from doc/source into doc/html.  It takes about
-9 seconds to run.
-
-If you want to run doctest on all of the *.txt files in doc/source, use the
-"testall" program from the doctest-tools package:
-
-    $ cd doc
-    $ testall
-
<< < 1 2 (Page 2 of 2)