Diff of /README [73803c] .. [f00035]  Maximize  Restore

  Switch to unified view

a/README b/README
...
...
8
rules.
8
rules.
9
9
10
COPYRIGHT AND LICENSE:
10
COPYRIGHT AND LICENSE:
11
11
12
This is published under the MIT License.  The copyright and license are in
12
This is published under the MIT License.  The copyright and license are in
13
the file "copyright_license".
13
the file "LICENSE" in the source directory.
14
14
15
DOCUMENTATION:
15
DOCUMENTATION:
16
16
17
The documentation is at:
17
The complete documentation is at:
18
18
19
    http://pyke.sourceforge.net
19
    http://pyke.sourceforge.net
20
20
21
You can download a copy of this documentation to your hard drive:
21
A copy of the html documentation is also included in the "doc/html" directory
22
22
within the source distribution.
23
    pyke_doc_html-1.0.3.zip
24
23
25
See the end of this file for how to regenerate the html files.
24
See the end of this file for how to regenerate the html files.
26
25
27
26
28
INSTALLATION:
27
REQUIREMENTS:
29
28
30
Pyke requires python 2.5 (or later).  Check with:
29
Pyke requires python 2.5 or later.  Check with:
31
30
32
    $ python --version
31
    $ python --version
33
32
34
You can download python at:
33
You can download python at:
35
34
36
    http://www.python.org
35
    http://www.python.org
37
36
38
37
38
TO INSTALL:
39
40
    1. Download and unzip the source distribution for the version of Python
41
       that you want to use.
42
43
       If you want to use Python 2.5 or 2.6, you need to use the pyke-1.0.3.zip
44
       sources.
45
46
       If you want to use Python 3.x, you need to use the pyke3.1-1.0.3.zip
47
       sources.
48
49
    2. Open a command line window in the directory above.
50
    3. Run "python setup.py build"
51
    4. As administrator, run: "python setup.py install"
52
53
39
SOURCE DISTRIBUTION:
54
SOURCE DISTRIBUTION:
40
55
41
There is a separate set of Pyke sources for Python3.1.
56
The source distribution contains the pyke source code, documentation (both
42
57
source and html), unit tests, and examples.
43
The pyke source distribution is the file:
44
45
    pyke-1.0.3.zip
46
47
This contains the pyke source code, documentation (both source and html), and
48
examples.
49
58
50
EXAMPLES:
59
EXAMPLES:
51
60
52
Pyke examples may be downloaded separately from sourceforge if you've used
61
Each example is in a separate subdirectory under the "examples" directory.
53
easy_install to install pyke (or installed the .egg file):
54
55
    pyke_examples-1.0.3.tar.gz
56
57
You need to unpack this into a directory that is on your PYTHON PATH.
58
59
Each example has a README file that explains how to run it.
62
Each example has a README file that explains how to run it.
60
63
61
The family_relations example is a good place to start.  It shows several
64
The family_relations example is a good place to start.  It shows several
62
solutions to the same problem.  It also has an example of a few rule
65
solutions to the same problem.  It also has an example of a few rule
63
optimizations that result in a 100 times performance improvement on this
66
optimizations that result in a 100 times performance improvement on this
...
...
88
91
89
The findall, forall, knapsack, notany and towers_of_hanoi examples are each
92
The findall, forall, knapsack, notany and towers_of_hanoi examples are each
90
very small.
93
very small.
91
94
92
95
93
TO INSTALL FROM THE SOURCES:
94
95
    $ python setup.py install
96
97
96
98
RUNNING DOCTESTS:
97
RUNNING DOCTESTS:
99
98
100
Pyke uses the doctest-tools package to run its doctests.  You can run the
99
Pyke uses the doctest-tools package to run its doctests.  You can run the
101
"testall" program from doctest-tools in any subdirectory, or in the top-level
100
"testall" program from doctest-tools in any subdirectory, or in the top-level
102
directory.  You can install doctest-tools with:
101
directory.  You can install doctest-tools as administrator with:
103
102
104
    $ sudo easy-install doctest-tools
103
    # easy-install doctest-tools
105
104
106
The top-level directory also has it's own "testall" script that removes all
105
The top-level directory also has it's own "testpyke" script that removes all
107
compiled_krb directories, then runs the standard testall scripts twice.  The
106
compiled_krb directories, then runs the testall script (from doctest-tools)
108
first time forces pyke to recompile everything, and the second time runs the
107
twice.  The first time forces pyke to recompile everything, and the second
109
same tests again having pyke re-use the compiled results from the previous
108
time runs the same tests again having pyke re-use the compiled results from
110
run.  This "testall" program should not be on your path, so run it as:
109
the previous run.  If the "testpyke" program is not on your path, run it as:
111
110
112
    $ ./testall
111
    $ ./testpyke
113
114
to distinguish it from the "testall" program installed with doctest-tools.
115
112
116
113
117
WORKING WITH THE SOURCE CODE REPOSITORY:
114
WORKING WITH THE SOURCE CODE REPOSITORY:
118
115
119
If you want to run Python3.1, read this:
116
If you want to run Python3.1, read this: