summaryrefslogtreecommitdiffstats
path: root/docs/README
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2005-08-08 17:32:25 +0000
committerLennart Poettering <lennart@poettering.net>2005-08-08 17:32:25 +0000
commit9ad2a95c80ab0f9cf48d3f58e9a7ed6f06685c34 (patch)
tree2db6a9e1969ca9e9cb916759c0c7e8f15cf8dbdc /docs/README
parent0556d428a56bdc4dac52d6eed2c515e66958094e (diff)
* documentation update
* embed CSS data in xmltoman.xsl git-svn-id: file:///home/lennart/svn/public/avahi/trunk@274 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe
Diffstat (limited to 'docs/README')
-rw-r--r--docs/README53
1 files changed, 44 insertions, 9 deletions
diff --git a/docs/README b/docs/README
index dfaf409..37aaf2c 100644
--- a/docs/README
+++ b/docs/README
@@ -1,11 +1,46 @@
-* Quick start guide:
-0) make sure you read the INSTALL file.
-1) start the deamon in background as root: avahi-daemon -D
-Or (You shouldn't start avahi-daemon and avahi-discover at the same time.)
-1) start the Gui to browse zeroconf network as your user: avahi-discover
+Avahi is a free, LGPL mDNS/DNS-SD implementation.
+Copyright 2004, 2005 by the Avahi developers.
-* Basic instructions to control the avahi deamon (as root):
-- starting it: avahi-daemon
-- starting it in background: avahi-daemon -D
-- stopping it: avahi-daemon -k
+ http://www.freedesktop.org/Software/Avahi
+
+Avahi has a mailing list:
+
+ http://lists.freedesktop.org/mailman/listinfo/avahi
+
+You have a chance to meet the developers on
+
+ #avahi on irc.freenode.org
+
+Please report bugs to the freedesktop.org bugzilla:
+
+ http://bugs.freedesktop.org/
+
+Avahi's SVN repository is freely accessible:
+
+ svn checkout svn://svn.0pointer.de/flexmdns/trunk avahi
+
+ http://0pointer.de/cgi-bin/viewcvs.cgi/?root=flexmdns
+
+Avahi has the following requirements:
+ - glib2
+ - expat
+ - libdaemon (http://0pointer.de/lennart/projects/libdaemon/)
+ - Linux 2.4 or 2.6
+ - DBUS 0.3x (optional, if you disable this, the daemon is not
+ accessible over IPC to other applications!)
+ - gtk2 + glade (optional, needed for avahi-discover-standalone)
+ - doxygen (optional, needed for he API documentaton)
+ - Python 2.4, pygtk2 (optional, needed by all client tools)
+ - python-twisted (optional, needed by avahi-bookmarks)
+
+Please make sure to read the currently available documentation for avahi before
+asking for support on the mailing list:
+
+ - INSTALL
+ - Man pages
+ - Homepage http://www.freedesktop.org/Software/Avahi
+ - Mailing list archive http://lists.freedesktop.org/archives/avahi/
+
+
+$Id$