1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/README.txt Wed Sep 28 17:08:56 2005 +0000
1.3 @@ -0,0 +1,54 @@
1.4 +Introduction
1.5 +------------
1.6 +
1.7 +The parallel module provides elementary support for parallel programming in
1.8 +Python using a fork-based process creation model in conjunction with a
1.9 +channel-based communications model implemented using socketpair and poll.
1.10 +
1.11 +Quick Start
1.12 +-----------
1.13 +
1.14 +Try running some of the tests:
1.15 +
1.16 +PYTHONPATH=. python tests/create_loop.py
1.17 +PYTHONPATH=. python tests/start_loop.py
1.18 +
1.19 +(Simple loop demonstrations which use two different ways of creating and
1.20 +starting the parallel processes.)
1.21 +
1.22 +PYTHONPATH=. python tests/start_indexer.py <n> <directory>
1.23 +
1.24 +(A text indexing demonstration, where <n> should be replaced by the number of
1.25 +created/child/worker processes which will attempt to tokenize text files, and
1.26 +where <directory> should be a directory containing text files to be indexed,
1.27 +although HTML files will also work well enough. After indexing the files, a
1.28 +prompt will appear, words or word fragments can be entered, and matching words
1.29 +and their locations will be shown.)
1.30 +
1.31 +Contact, Copyright and Licence Information
1.32 +------------------------------------------
1.33 +
1.34 +No Web page has yet been made available for this work, but the author can be
1.35 +contacted at the following e-mail address:
1.36 +
1.37 +paul@boddie.org.uk
1.38 +
1.39 +Copyright and licence information can be found in the docs directory - see
1.40 +docs/COPYING.txt and docs/LICENCE.txt for more information.
1.41 +
1.42 +Dependencies
1.43 +------------
1.44 +
1.45 +This software depends on standard library features which are stated as being
1.46 +available only on "UNIX"; it has only been tested on a GNU/Linux system.
1.47 +
1.48 +Release Procedures
1.49 +------------------
1.50 +
1.51 +Update the parallel __version__ attribute.
1.52 +Change the version number and package filename/directory in the documentation.
1.53 +Update the release notes (see above).
1.54 +Check the release information in the PKG-INFO file.
1.55 +Tag, export.
1.56 +Archive, upload.
1.57 +Update PyPI, PythonInfo Wiki, Vaults of Parnassus entries.