complete INSTALL.txt

mention installation instructions in README, setup.py comment header,
release notes, web page, and notes/test.txt.  Reorganize start of test.txt

Author: jon-jacky

INSTALL.txt

@@ -1,7 +1,7 @@
 
 To use PyModel, you do not need to install anything into any system
-directories.  Just obtain the PyModel directory and place it at any
-convenient location.  To get the current development version,
+directories.  Just obtain the PyModel directory and place it under
+your home directory.  To get the current development version,
 
  git clone git@github.com:jon-jacky/PyModel.git
 
@@ -14,15 +14,33 @@ or
 
  http://staff.washington.edu/jon/pymodel/www/
 
-Then unpack ...
-
-... execute pymodel_paths ...  rename PyModel-1.0 to just PyModel (or 
-edit the commands) ...
-
-The setup.py script now supports the install argument, to optionally
-install the PyModel python modules and commands in system directories.
-
-... source tpath ...
-
-... install does not do anything with samples or docs ...
-
+Then unpack using a tar or zip utility.  Then you can run PyModel
+using the commands and modules in the unpacked distribution directory.
+Just put PyModel/bin on your execution PATH and PyModel/pymodel on
+your PYTHONPATH.  You can achieve this by executing the script
+PyModel/bin/pymodel_paths (or pymodel_paths.bat on Windows).  That
+script assumes the distribution directory is in your HOME directory
+and is named PyModel (not PyModel-1.0, so you many need to rename it).
+
+Confirm that PyModel works for you by running some of the test scripts
+in the samples directories.  For example, in
+PyModel/samples/PowerSwitch, type the command: trun test (not python
+test.py).  You should then see output from several runs of the pmt
+program as it executes the PowerSwitch model.
+
+The setup.py script included in the distribution now supports the
+install argument, so you can optionally install the PyModel python
+modules and commands in system directories (for example in
+/Library/Python/2.7/site-packages and /usr/local/bin, respectively).
+In the PyModel directory, type the command: sudo python setup.py
+install.    Then you should not need to execute pymodel_path, but 
+You still need to type the command: source tpath (in Windows, just tpath)
+in every session (terminal window).
+
+Most of the distribution is in the examples under PyModel/samples, and
+in the documentation under PyModel/notes, www, and talks, and in the
+README files in most directories.  Installation does not install these
+into any system directories; find them under the unpacked PyModel
+distribution directory.
+
+Revised May 2013

README.md

@@ -58,8 +58,11 @@ For more information, read the [notes](notes), browse the
 or try the [samples](samples).  There are README files in most of the
 directories.
 
+You can [INSTALL](INSTALL.txt) PyModel.
+
 PyModel is also available at
-[PyPI](http://pypi.python.org/pypi/PyModel).
+[PyPI](http://pypi.python.org/pypi/PyModel) and at the 
+author's [web page](http://staff.washington.edu/jon/pymodel/www/).
 
 PyModel requires Python 2.6 or higher (because it uses *itertools.product*)
 
@@ -73,6 +76,3 @@ Code and documents are copyright (C) 2009-2013, Jonathan Jacky.
 
 
 Revised May 2013
-
-
-

notes/release-1.0.txt

@@ -4,7 +4,9 @@ PyModel v 1.0 release notes
 PyModel is a model-based testing framework for Python.  Earlier public
 releases were versions 0.80 in Jan 2010, 0.85 in Mar 2010, and 0.90 in
 July 2011.  Since July 2011 ongoing work has been available at GitHub:
-https://github.com/jon-jacky/PyModel/  
+https://github.com/jon-jacky/PyModel/  PyModel can also be downloaded
+from PyPI http://pypi.python.org/pypi/PyModel or the author's web page
+http://staff.washington.edu/jon/pymodel/www/
 
 This release is called version 1.0 because it includes all of the
 features considered in the original project plan.  (Development and
@@ -108,3 +110,4 @@ Version 1.0 makes some bug fixes:
 
 - The pmt -o offline test generator option works.
 
+Revised May 2013

notes/test.txt

@@ -1,5 +1,18 @@
 Notes on tests
 
+Introduction
+Prerequisites
+Running tests
+Command summary
+Commands and modules
+Test scripts
+Checking test script output
+Output files
+Using other unit testing frameworks
+
+
+Introduction
+
 These notes explain how to script and run tests on the PyModel
 software itself.  These notes are not about using PyModel to test
 other programs -- that is described elsewhere.
@@ -24,15 +37,6 @@ conventional unit test framework like unittest or nose) because:
 The last section (below) explains how to script tests similar to ours
 using the unittest module from the Python standard library.
 
-Prerequisites
-Running tests
-Command summary
-Commands and modules
-Test scripts
-Checking test script output
-Output files
-Using other unit testing frameworks
-
 
 Prerequisites
 
@@ -46,14 +50,24 @@ contents of its PyModel/bin directory are on your execution path, and
 your current directory is on your Python path.  You can achieve this
 by executing PyModel/bin/pymodel_paths, or the commands therein.
 Alternatively, you can install the contents of PyModel/pymodel and
-PyModel/bin into system directories (see INSTALL.txt) but then you may
-need to execute the command "source tpath" in each session (terminal
-window) before you execute any PyModel commands.
+PyModel/bin into system directories but then you may need to execute
+the command "source tpath" in each session (terminal window) before
+you execute any PyModel commands (or just "tpath" on Windows).
+For more details see PyModel/INSTALL.txt.
 
 
 Running tests
 
-In each subdirectory of samples, type:
+Confirm that PyModel works for you by running some of the test scripts
+in the samples directories.  For example, in
+PyModel/samples/PowerSwitch, type the command:
+
+ trun test 
+
+(not python test.py).  You should then see output from several runs of
+the pmt program as it executes the PowerSwitch model.
+
+To run regression tests that confirm tests generate the expected output, type:
 
  tdiff trun test
 

setup.py

@@ -10,11 +10,23 @@
  python setup.py sdist -v -f --formats=gztar,zip upload --show-response
 
 It is not necessary to install, you can just run out of the unpacked
-distribution. In that case, it is convenient to run PyModel/bin/pymodel_paths
-to set up your PATH and PYTHONPATH (run pymodel_paths.bat on Windows).
+distribution. In that case, it is convenient to run
+PyModel/bin/pymodel_paths to set up your PATH and PYTHONPATH (run
+pymodel_paths.bat on Windows).  That script assumes the distribution
+directory is in your HOME directory and is named PyModel (not
+PyModel-1.0, so you many need to rename it).
 
-The distribution contents are all specified in MANIFEST.in,
-not in setup.py.  Therefore python setup.py install has no effect.
+To optionally install the PyModel python modules and commands in
+system directories (for example in /Library/Python/2.7/site-packages
+and /usr/local/bin, respectively):
+
+ sudo python setup.py install.
+
+The distribution contents are all specified in MANIFEST.in, not in
+setup.py.  Most of the distribution is in the examples under
+PyModel/samples, and in the documentation under PyModel/notes, www,
+and talks, and in the README files in most directories.  Installation
+does not install these into any system directories
 """
 
 from distutils.core import setup

www/index.html

@@ -93,6 +93,10 @@ <h2>PyModel: Model-based testing in Python</h2>
 You may download <a href="PyModel-1.0.tar.gz">PyModel-1.0.tar.gz</a> or 
 <a href="PyModel-1.0.zip">PyModel-1.0.zip</a>.
 
+<p>
+Then you can <a href="../INSTALL.txt">INSTALL</a> PyModel.
+</p>
+
 <p>
 PyModel is also available at 
 <a href="http://pypi.python.org/pypi/PyModel">PyPI</a>