summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorSimon McVittie <simon.mcvittie@collabora.co.uk>2006-12-18 20:33:56 +0000
committerSimon McVittie <simon.mcvittie@collabora.co.uk>2006-12-18 20:33:56 +0000
commite6eb7b5307da2a446e1c8c6b0cb6b11fc6705b00 (patch)
tree3315ae510245c0a0b4d791b7c1d73f1bc01afdce /README
parent73457d0e435f4a9be9a9980fb06dd004b87c6647 (diff)
Switch to autotools and test with Python 2.5 as well as 2.4.
In the process: HACKING.txt: update include/dbus-python.h: add some typedefs to make it saner bus.c, conn.c, conn-methods.c: further alter docstrings to keep epydoc happy exceptions.c: create exceptions in a more longwinded way for Python 2.5 compatibility message-get-args.c, bus/__init__.py: tweak docstrings dbus/introspect_parser.py: make docstring valid reStructuredText run-test.sh: simplify, since configure now does some of the work test/*.py: use paths from run-test.sh, cope with out-of-tree builds test-standalone.py: carry out additional sanity checks
Diffstat (limited to 'README')
-rw-r--r--README33
1 files changed, 33 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..0645823
--- /dev/null
+++ b/README
@@ -0,0 +1,33 @@
+======================================
+dbus-python: Python bindings for D-Bus
+======================================
+
+:Author: Simon McVittie, `Collabora`_
+:Date: 2006-12-18
+
+.. Collabora: http://www.collabora.co.uk/
+
+Usage
+=====
+
+For client code, see the docstring for dbus/__init__.py.
+
+To export objects, see the docstring for dbus/service.py.
+
+To develop on dbus-python, see HACKING.txt.
+
+Building the API documentation
+==============================
+
+Because the API documentation is generated with a pre-release version of
+epydoc, it's not currently built by default. To do so, install
+`epydoc`_ 3 alpha and `docutils`_, and run ``./configure`` with the
+``--enable-api-docs`` option. Documentation starts from ``api/index.html``.
+
+.. epydoc: http://epydoc.sourceforge.net/
+.. python-docutils: http://docutils.sourceforge.net/
+
+For now, a copy of the documentation (updated for each release candidate)
+can be found here: `dbus-python API documentation on people.freedesktop.org`__
+
+__ http://people.freedesktop.org/~smcv/dbus-python-0.8pre/epydoc/