summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorSimon McVittie <simon.mcvittie@collabora.co.uk>2007-01-24 14:31:54 +0000
committerSimon McVittie <simon.mcvittie@collabora.co.uk>2007-01-24 14:31:54 +0000
commit057317ea759323f49133351e997ce7b892394889 (patch)
tree14e1cb8d3ece6a7c7e048b455b92b4281b5a2018 /README
parentbdf3c3a8ca30149b8d047ac0437858a47927f37e (diff)
Update NEWS, README for 0.80.0
Diffstat (limited to 'README')
-rw-r--r--README33
1 files changed, 21 insertions, 12 deletions
diff --git a/README b/README
index f24cdc5..611d2df 100644
--- a/README
+++ b/README
@@ -1,21 +1,30 @@
-======================================
-dbus-python: Python bindings for D-Bus
-======================================
+=======================================
+dbus-python_: Python bindings for D-Bus
+=======================================
-:Author: Simon McVittie, `Collabora`_
-:Date: 2006-12-18
-:Version: 0.80rc3 (internally, 0.79.93)
-
-.. _Collabora: http://www.collabora.co.uk/
+.. _dbus-python: http://www.freedesktop.org/wiki/Software/DBusBindings#python
Usage
=====
+Online documentation can be found at
+<http://dbus.freedesktop.org/doc/dbus-python/>.
+
+There is an incomplete tutorial in `doc/tutorial.txt`__
+(if you compile dbus-python with ``rst2html`` installed or you're reading
+this document on the D-Bus website, there's also an `HTML version`__).
+
+__ doc/tutorial.txt
+__ doc/tutorial.html
+
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.
+To develop on dbus-python, see `doc/HACKING.txt`__ or the `HTML version`__.
+
+__ doc/HACKING.txt
+__ doc/HACKING.html
Building the API documentation
==============================
@@ -28,7 +37,7 @@ epydoc, it's not currently built by default. To do so, install
.. _epydoc: http://epydoc.sourceforge.net/
.. _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`__
+A copy of the documentation can be found here:
+`dbus-python API documentation on people.freedesktop.org`__
-__ http://people.freedesktop.org/~smcv/dbus-python-0.8pre/epydoc/
+__ http://dbus.freedesktop.org/doc/dbus-python/api/