summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichele Simionato <michele.simionato@gmail.com>2019-03-16 07:53:46 +0100
committerMichele Simionato <michele.simionato@gmail.com>2019-03-16 07:53:46 +0100
commit6d3c7f75a4078ed9b8ce64fb6cc5a87e1bad09c0 (patch)
treea02296e254af2aba2021cd73a3718d710c5f21d4
parent0014dd8971752fb8a1d23527b9112aba267df2d5 (diff)
downloadpython-decorator-git-6d3c7f75a4078ed9b8ce64fb6cc5a87e1bad09c0.tar.gz
Fix
-rw-r--r--README.md1
-rw-r--r--README.rst60
2 files changed, 60 insertions, 1 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index 1fb899d..0000000
--- a/README.md
+++ /dev/null
@@ -1 +0,0 @@
-[Here is the README](README.rst)
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..62539ac
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,60 @@
+Decorator module
+=================
+
+The goal of the decorator module is to make it easy to define
+signature-preserving function decorators and decorator factories.
+It also includes an implementation of multiple dispatch and other niceties
+(please check the docs). It is released under a two-clauses
+BSD license, i.e. basically you can do whatever you want with it but I am not
+responsible.
+
+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, clone the `GitHub repo`_ or download the tarball_, unpack it and run
+
+ ``$ pip install .``
+
+in the main directory, possibly as superuser.
+
+.. _tarball: http://pypi.python.org/pypi/decorator
+.. _GitHub repo: https://github.com/micheles/decorator
+
+Testing
+--------
+
+If you have the source code installation you can run the tests with
+
+ `$ 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 we kept backward-compatibility for a long time.
+
+Repository
+---------------
+
+The project is hosted on GitHub. You can look at the source here:
+
+ https://github.com/micheles/decorator
+
+Documentation
+---------------
+
+The documentation has been moved to https://raw.githubusercontent.com/micheles/decorator/master/docs/documentation.md
+
+From there you can get a PDF version by simply using the print
+functionality of your browser.
+