finish release notes for version 1.0

Author: jon-jacky

notes/release-1.0.txt

@@ -19,7 +19,7 @@ Version 1.0 adds new functionality:
   invariants.  The PyModel Graphics program pmg indicates unsafe states
   in the generated graphs.
 
-- The new PyModel Viewer command combines the functionality of the
+- The new PyModel Viewer command pmv combines the functionality of the
   PyModel Analyzer pma, the PyModel Graphics program pmg, and the
   Graphviz dot program in a single command, for convenience and
   brevity.
@@ -40,37 +40,59 @@ Version 1.0 adds new functionality:
 
 Version 1.0 adds a new sample and revises all the others:
 
-- Socket sample and writeup, asynch steppers using threads or
-  select, socket_simulator and select_simulator
+- The completely rewritten Socket sample includes new asynchronous
+  steppers (test harnesses) that show how to support asynchrony and
+  nondeterminism using the select function, or alternatively, using
+  threads.  The Socket sample also includes new simulators that can
+  optionally replace the the Python standard library socket and select
+  modules, to demonstrate greater nondeterminism and transmission
+  errors.
 
-- Especially, more documentation for the samples: samples/README.md
-  and README.md in each samples directory that explains every file
+- The new safety sample demonstrates state invariants and safety analysis.
 
-- svg/ and fsmpy/ dirs new .ref files, 
+- There are new fsmpy/ and svg/ directories in each sample that
+  contain FSM modules and SVG graphics files generated by the commands
+  in the test scripts.
 
-Version 1.0 reorganizes some code and directory structure:
+- Many sample test scripts (test*.py modules) have been revised and
+  the corresponding reference output (*.ref files) has been
+  regenerated.
+
+Version 1.0 adds much new documentation and revises the rest:
 
-- new bin directory separated from pymodel directory
+- There are new README.md (Markdown format) files in PyModel in most
+  top-level directories below PyModel.
 
-- separate out models.py base class for ModelProgram, FSM, TestSuite
+- The new README.md in the samples directory briefly describes every
+  sample.  The new README.md in each sample directory explains that
+  sample in more detail, and describes every file in that sample.
 
-Version 1.0 adds new documentation and revises much of the rest:
+- The documentation in the notes directory has been expanded and
+  brought up to date.  There are new and revised .txt files. Some .txt
+  files have been replaced by .md (Markdown format) files.
 
-- More documentation New README.md files in PyModel in most top-level
- directories below PyModel
+- The web pages in the www directory have been expanded and brought up
+  to date.  The content in these pages is drawn from .md files 
+  and .txt files in other PyModel directories.
 
-- Revised .txt files in notes/
+Version 1.0 reorganizes some code and directory structure:
 
-- Revised .html files in www/, new .html files generated from new .md
-  files in other directories
+- There is a new bin directory for commands and scripts, separated
+  from the pymodel directory for Python modules.
+
+- There is a new model.py module that contains the Model base class
+  for the ModelProgram, FSM, TestSuite classes.
 
 Version 1.0 makes some bug fixes:
 
-- fix crash when missing parameter generator, now print
-          helpful error msg and exit cleanly
+- The programs no longer crash when a parameter generator is missing. 
+  Now they issue a helpful error message and exit.
+
+- The pmt program cancels the timeout when a timeout was requested but
+  did not expire.
 
-- cancel timeout when timeout was requested but didn't expire
+- When models are composed, omitted arguments are handled correctly
+  (usually, as "match any" indicators).
 
-- Correctly handle empty args in composition
+- The pmt -o offline test generator option works.
 
-- pmt -o offline test generator option

www/index.html

@@ -90,8 +90,8 @@ <h2>PyModel: Model-based testing in Python</h2>
 SciPy 2011 Proceedings.
 
 <p>
-You may download <a href="PyModel-0.9.tar.gz">PyModel-0.9.tar.gz</a> or 
-<a href="PyModel-0.9.zip">PyModel-0.9.zip</a>.
+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>
 PyModel is also available at 
@@ -118,7 +118,7 @@ <h2>PyModel: Model-based testing in Python</h2>
 <a href="http://staff.washington.edu/jon/">Jonathan Jacky</a>
 
 <p>
-Revised Apr 2013
+Revised May 2013
 
 </body>
 </html>