X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=README;h=1233fd772cd299704830e8a1073d20cc9dab02d5;hb=59adc052f88d168d3985b02ad398c1081ea81917;hp=3b0696e7bd42c60d07681966d8cd5b22f6d5d3e9;hpb=14b64d63bc620fce2008437a874bf285ac9b8e6e;p=catta

diff --git a/README b/README
index 3b0696e..1233fd7 100644
--- a/README
+++ b/README
@@ -1,10 +1,28 @@
-* Quick start guide:
-0) make sure you read the INSTALL file.
-1) start the deamon in background as root: avahi -D
-2) start the Gui to browse zeroconf network as your user: avahi-discover
+A stripped-down version of the Avahi service discovery suite
+containing only the common and core components
 
 
-* Basic instructions to control the avahi deamon (as root):
-- starting it:			avahi
-- starting it in background:	avahi -D
-- stopping it:			avahi -k
+TO BUILD FROM GIT:
+
+./bootstrap         # first time
+./configure ...     # if other flags desired
+make
+make check          # to run some tests
+
+requires: libtool, pkgconfig, autoconf, automake
+
+
+TO BUILD THE API DOCUMENTATION:
+
+make doxygen-doc
+
+requires: doxygen
+
+
+CONFIGURE SWITCHES:
+
+--enable-tests
+build some test programs, including those for 'make check'.
+
+--enable-core-docs
+include files from 'avahi-core' when building the doxygen docs.