[Checkins] SVN: manuel/trunk/s - include the table example in the PyPI page
Benji York
benji at zope.com
Sun Jun 7 12:03:04 EDT 2009
Log message for revision 100705:
- include the table example in the PyPI page
- tweak the package description
Changed:
U manuel/trunk/setup.py
U manuel/trunk/src/manuel/README.txt
-=-
Modified: manuel/trunk/setup.py
===================================================================
--- manuel/trunk/setup.py 2009-06-07 15:46:25 UTC (rev 100704)
+++ manuel/trunk/setup.py 2009-06-07 16:03:04 UTC (rev 100705)
@@ -12,10 +12,8 @@
author='Benji York',
author_email='benji at benjiyork.com',
description=
- 'Documentation and testing are important parts of software '
- 'development. Often they can be combined such that you get tests '
- 'that are well documented or documentation that is well tested. '
- 'That\'s what Manuel is about.',
+ 'Manuel lets you combine traditional doctests with new test syntax '
+ 'that you build yourself or is inlcuded in Manuel.',
license='ZPL',
install_requires=[
'setuptools',
@@ -25,6 +23,8 @@
long_description = (
open(os.path.join('src', 'manuel', 'README.txt')).read()
+ '\n\n'
+ + open(os.path.join('src', 'manuel', 'table-example.txt')).read()
+ + '\n\n'
+ open('CHANGES.txt').read()
)
)
Modified: manuel/trunk/src/manuel/README.txt
===================================================================
--- manuel/trunk/src/manuel/README.txt 2009-06-07 15:46:25 UTC (rev 100704)
+++ manuel/trunk/src/manuel/README.txt 2009-06-07 16:03:04 UTC (rev 100705)
@@ -8,9 +8,11 @@
Overview
========
-Manuel parses documents, evaluates their contents, then formats the result of
-the evaluation.
+In short, Manuel parses documents (tests), evaluates their contents, then
+formats the result of the evaluation.
+For a quick introduction to Manuel, take a look at the `FIT Table Example`_.
+
The core functionality is accessed through an instance of a Manuel object. It
is used to build up the handling of a document type. Each phase has a
corresponding slot to which various implementations are attached.
More information about the Checkins
mailing list