diff options
| author | micheles <micheles@micheles-mac> | 2010-05-22 10:03:23 +0200 |
|---|---|---|
| committer | micheles <micheles@micheles-mac> | 2010-05-22 10:03:23 +0200 |
| commit | aebf8739347796ab2312c5c330f408baaff8ad93 (patch) | |
| tree | 4e91b63a6c84616ab89afcea26ec1c8b48a312d6 /decorator/README.txt | |
| parent | 4ffb6bd356fdfd4451402e5141e3deb552340a32 (diff) | |
| download | micheles-aebf8739347796ab2312c5c330f408baaff8ad93.tar.gz | |
Various improvements to the documentation
Diffstat (limited to 'decorator/README.txt')
| -rw-r--r-- | decorator/README.txt | 44 |
1 files changed, 33 insertions, 11 deletions
diff --git a/decorator/README.txt b/decorator/README.txt index 8469081..1fb5097 100644 --- a/decorator/README.txt +++ b/decorator/README.txt @@ -1,15 +1,32 @@ Decorator module
----------------------------
+=================
Dependencies:
The decorator module requires Python 2.4.
-Installation:
+Installation
+-------------
+
+If you are lazy, just perform
+
+$ easy_install decorator
+
+which will install just the module on your system. Notice that
+Python 3 requires the easy_install version of the distribute_ project.
+
+If you prefer to install the full distribution from source, including
+the documentation, download the tarball_, unpack it and run
$ python setup.py install
-Testing:
+in the main directory, possibly as superuser.
+
+.. _tarball: http://pypi.python.org/pypi/decorator
+.. _distribute: http://packages.python.org/distribute/
+
+Testing
+--------
For Python 2.4, 2.5, 2.6, 2.7 run
@@ -22,16 +39,21 @@ $ python documentation3.py You will see a few innocuous errors with Python 2.4 and 2.5, because
some inner details such as the introduction of the ArgSpec namedtuple
and Thread.__repr__ changed. You may safely ignore them.
+Notice that you may run into trouble if in your system there is an older version
+of the decorator module; in such a case remove the old version.
-Notice:
+Documentation
+--------------
-You may get into trouble if in your system there is an older version
-of the decorator module; in such a case remove the old version.
+There are various versions of the documentation:
-Documentation:
+- `HTML version (Python 2)`_
+- `PDF version (Python 2)`_
-There are two versions of the documentation, one for `Python 2`_ and one
-for `Python 3`_ .
+- `HTML version (Python 3)`_
+- `PDF version (Python 3)`_
-.. _Python 2: documentation.html
-.. _Python 3: documentation3.html
+.. _HTML version (Python 2): documentation.html
+.. _PDF version (Python 2): documentation.pdf
+.. _HTML version (Python 3): documentation3.html
+.. _PDF version (Python 3): documentation3.pdf
|