]> git.meshlink.io Git - catta/commitdiff
put some useful info into the README
authorSven M. Hallberg <pesco@khjk.org>
Mon, 18 Aug 2014 15:53:28 +0000 (17:53 +0200)
committerSven M. Hallberg <pesco@khjk.org>
Mon, 18 Aug 2014 15:55:04 +0000 (17:55 +0200)
README

diff --git a/README b/README
index 832874ce9ed3f2de4acf7e3e90048c9be2156136..3efe4fb8aa89744e70dd24ff29fc96dacb21b391 100644 (file)
--- 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.