diff options
Diffstat (limited to 'docs/README.rst')
| -rw-r--r-- | docs/README.rst | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/docs/README.rst b/docs/README.rst new file mode 100644 index 0000000..3a6bb3f --- /dev/null +++ b/docs/README.rst @@ -0,0 +1,62 @@ +Decorator module
+=================
+
+:Author: Michele Simionato
+:E-mail: michele.simionato@gmail.com
+:Requires: Python 2.6+
+:Download page: http://pypi.python.org/pypi/decorator
+:Installation: ``pip install decorator``
+:License: BSD license
+
+Installation
+-------------
+
+If you are lazy, just perform
+
+ `$ pip install decorator`
+
+which will install just the module on your system.
+
+If you prefer to install the full distribution from source, including
+the documentation, download the tarball_, unpack it and run
+
+ `$ python setup.py install`
+
+in the main directory, possibly as superuser.
+
+.. _tarball: http://pypi.python.org/pypi/decorator
+
+
+Testing
+--------
+
+Run
+
+ `$ python src/tests/test.py -v`
+
+or (if you have setuptools installed)
+
+ `$ python setup.py test`
+
+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. It is safe even to copy the module `decorator.py` over
+an existing one, since version 4.0 is backward-compatible.
+
+Documentation
+--------------
+
+There are various versions of the documentation:
+
+- `HTML version`_
+- `PDF version`_
+
+.. _HTML version: http://pypi.python.org/pypi/decorator/documentation.html
+.. _PDF version: https://github.com/micheles/decorator/blob/4.0.1/documentation.pdf
+
+Repository
+---------------
+
+The project is hosted on GitHub. You can look at the source here:
+
+ https://github.com/micheles/decorator
|
