Skip to content

Commit 2bf0074

Browse files
committed
revise README in pymodel and bin directories
also remove bin/pymodel_symlinks, superceded by new bin/pma etc. commands
1 parent 57771ac commit 2bf0074

File tree

3 files changed

+29
-28
lines changed

3 files changed

+29
-28
lines changed

bin/README.md

+24-11
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

2-
bin directory
3-
=============
2+
PyModel bin directory
3+
=====================
44

55
This directory contains the commands for PyModel.
66

@@ -16,20 +16,33 @@ commands.
1616
The commands are:
1717

1818
- *pma*, *pmg*, *pmt*, *pmv*: the four main PyModel commands. They
19-
just invoke the Python modules with the same names in the *pymodel*
20-
directory. See *commands.txt* in the *notes* directory, or print
19+
just run the Python modules with the same names in the *pymodel*
20+
directory. For details, see *commands.txt* in the *notes* directory, or print
2121
their built-in help by typing *pma -h* etc.
2222

23-
- *clogdiff*: works with trun.py to execute and check
24-
regression tests. See *test.txt* in the *notes* directory.
25-
26-
- *dotpdf*, *dotps*, *dotsvg*: invoke the Graphviz *dot* program to
23+
- *dotpdf*, *dotps*, *dotsvg*: run the Graphviz *dot* program to
2724
produce *.pdf*, *.ps*, or *.svg* graphics files from the *.dot*
2825
files generated by *pmg*
2926

30-
- *tpath*: put the current directory *.* (dot) on *PYTHONPATH*. This
31-
is needed by the PyModel programs *pmt* etc., which all import
32-
Python modules in the current directory that are named on the command line.
27+
- *trun*: runs test scripts, including sample demonstrations. See
28+
*test.txt* in the *notes* directory.
29+
30+
- *clogdiff*: works with *trun* to execute and check
31+
regression tests. See *test.txt* in the *notes* directory.
32+
33+
- *wsgirunner*: runs WSGI-compliant web applications on *localhost*,
34+
such as *webapp* in the *WebApplication* sample, or *wsgidemo* here.
35+
36+
- *pymodel_paths*: assigns paths for running PyModel from these *PyModel*
37+
directories. To prepare to use PyModel, execute this script,
38+
or put the commands from this script into your *.profile* or *.bashrc*.
39+
These commands add *PyModel/bin* to the execution
40+
*PATH*, and add *PyModel/pymodel* to the *PYTHONPATH*. They also
41+
add the current directory to the *PYTHONPATH*, because the
42+
PyModel programs *pmt* etc. all import Python modules in the
43+
current directory that are named on the command line.
44+
(If you install PyModel so its commands and modules are placed
45+
in system directories, you may no longer need these commands.)
3346

3447

3548
Revised Apr 2013

bin/pymodel_symlinks

-12
This file was deleted.

pymodel/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,18 @@ its modules are usually invoked through the commands in the PyModel
1616
The Python modules are:
1717

1818
- *pma*, *pmg*, *pmt*, *pmv*: the main modules for the four main
19-
PyModel programs. See *commands.txt* in the *notes* directory, or
20-
print their built-in help by typing *pma -h* etc.
19+
PyModel programs. For details, see *commands.txt* in the *notes*
20+
directory, or print their built-in help by typing *pma -h* etc.
2121

2222
- *trun*: runs test scripts, including sample demonstrations. See
2323
*test.txt* in the *notes* directory.
2424

25-
- *wsgirunner*: runs WSGI-compliant web applications on localhost
25+
- *wsgirunner*: runs WSGI-compliant web applications on *localhost*,
26+
such as *webapp* in the *WebApplication* sample, or *wsgidemo* here.
2627

2728
- *wsgidemo*: a sample web application to run with *wsgirunner*
2829

29-
- *ActionNameCoverage* and all the other modules are used
30-
by *pma*, *pmg*, *pmt*, and *pmv*.
30+
All the other modules here are used by *pma*, *pmg*, *pmt*, and *pmv*.
3131

3232

3333
Revised Apr 2013

0 commit comments

Comments
 (0)