Merge branch 'autotools'

[umurmur.git] / README

diff --git a/README b/README
index 5a1ba178eedce68cfe0d38e4fff43120e770f5a2..f56ef6b2b0dde285c39651b235c640b7a3abc9e4 100644 (file)
--- a/README
+++ b/README
@@ -2,33 +2,38 @@ README for uMurmur - minimalistic Mumble server
 ===============================================
 http://code.google.com/p/umurmur/
 
-Contains protobuf-c library code which is Copyright 2008, Dave Benson.
-See http://code.google.com/p/protobuf-c/
+uMurmur is available as a precompiled package for some distributions. Check
+your package repository if you are running OpenWRT or Freetz.
 
+There are makefiles in the openwrt subdirectory suitable for buildning with
+the OpenWRT SDK. Move the Makefile of choice to the base directory, e.g.:
+
+# mv openwrt/Makefile.polarssl Makefile
+
+and then put the whole umurmur-X.X.X directory in the SDK's 'packages'
+directory.
+
+
+Instructions for building from source:
 1. Requirements
-o OpenSSL library
-o libConfig
+o OpenSSL or PolarSSL library
+o libconfig
+o libprotoc-c (use --disable-protoc option in its ./configure)
 
 2. Build
-cd to src directory
-make
+o ./configure
+o make
 
 3. Install
-o Copy umurmurd from src directory to where you want it,
-  /usr/local/sbin/ for example.
+o make install
 o Edit umurmur.conf.example to your liking and put it in a suitable place.
   /etc/umurmur.conf is default.
 
-Some day I might put together an autoconf with the typical configure &&
-make && make install, but we'll see.
-
 4. Run
 As daemon:
-
 umurmurd -c <conf file> -p <PID file> -r
 
 For other switches and their meaning run:
-
 umurmurd -h
 
 A startup script can easily be created if you want to. Just copy an
@@ -37,4 +42,4 @@ existing script and edit it to your liking.
 5. Support/Contact/Documentation
 See the project page, link above.
 
-Have fun!
\ No newline at end of file
+Have fun!