From: Sven M. Hallberg <pesco@khjk.org>
Date: Mon, 18 Aug 2014 15:53:28 +0000 (+0200)
Subject: put some useful info into the README
X-Git-Url: http://git.meshlink.io/?p=catta;a=commitdiff_plain;h=c1d3d2fc0e675c52ff37dd1dda410ec9f405d64d

put some useful info into the README
---

diff --git a/README b/README
index 832874c..3efe4fb 100644
--- a/README
+++ b/README
@@ -1,34 +1,27 @@
-AVAHI SERVICE DISCOVERY SUITE
+A stripped-down version of the Avahi service discovery suite
+containing only the common and core components
 
-WEB SITE:
-	http://avahi.org/
 
-GIT:
-	git://git.0pointer.de/avahi.git
+TO BUILD FROM GIT:
 
-GITWEB:
-	http://git.0pointer.de/?p=avahi.git;a=summary
+./bootstrap
+./configure
+make
 
-MAILING LIST:
-	http://lists.freedesktop.org/mailman/listinfo/avahi
+requires: libtool, pkgconfig, autoconf, automake
 
-GIT COMMITS MAILING LIST:
-	https://tango.0pointer.de/mailman/listinfo/avahi-commits
 
-TRAC TICKET CHANGES MAILING LIST:
-	https://tango.0pointer.de/mailman/listinfo/avahi-tickets
+TO BUILD THE API DOCUMENTATION:
 
-IRC:
-	#avahi on irc.freenode.org
+make doxygen-doc
 
-CIA:
-	http://cia.navi.cx/stats/project/avahi
+requires: doxygen
 
-FRESHMEAT:
-	http://freshmeat.net/projects/avahi/
 
-OHLOH:
-	http://www.ohloh.net/projects/avahi/
+CONFIGURE SWITCHES:
 
-AUTHORS:
-	Several
+--enable-tests
+build some stuff for 'make check'.
+
+--enable-core-docs
+include files from 'avahi-core' when building the doxygen docs.