Add include <time.h> for CLOCK_MONOTONIC

[umurmur.git] / README.md

diff --git a/README.md b/README.md
index e3f7efba24a8de482693a62f5c37accf5cb46f56..29610ef2226b867a4f08bfbbbaa033f98d712f06 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,25 +1,21 @@
 uMurmur - minimalistic Mumble server
 ====================================
-Hosted on [GitHub](https://github.com/fatbob313/umurmur)
+Project page on [GoogleCode](http://code.google.com/p/umurmur/)
 
-uMurmur is a minimalistic Mumble server primarily targeted to run on routers with an open OS like OpenWRT. The server part of Mumble is called Murmur, hence the name uMurmur. It 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](https://github.com/fatbob313/umurmur/tree/master/openwrt) subdirectory suitable for building 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.
+Source hosted on [GitHub](https://github.com/fatbob313/umurmur)
 
+uMurmur is a minimalistic Mumble server primarily targeted to run on embedded computers, like routers, with an open OS like e.g. OpenWRT. The server part of Mumble is called Murmur, hence the name uMurmur. It is available as a precompiled package for quite a lot distributions. Check your distribution's package repository.
 
 Instructions for building from source
 -------------------------------------
 1. Requirements
-       * [OpenSSL](http://www.openssl.org/) or [PolarSSL](http://polarssl.org/) library
+       * [OpenSSL](http://www.openssl.org/) or [PolarSSL](http://polarssl.org/) library. For PolarSSL version 1.0.0 and above is required.
        * [libconfig](http://www.hyperrealm.com/libconfig/)
-       * [libprotoc-c](http://code.google.com/p/protobuf-c/) version 0.14 (use --disable-protoc option in its ./configure)
+       * [libprotoc-c](http://code.google.com/p/protobuf-c/) version 0.14 or 0.15 (use --disable-protoc option in its ./configure to build only the library). If you for some reason have to run an earlier version you need to recompile the protocol file `Mumble.proto` using the protobuf compiler for the corresponding version.
 
 2. Build
-       * `./configure`
+       * `./autogen.sh` - Required only if building from a cloned Git tree.
+       * `./configure` - use `./configure --help` for switches. Defaults to build using PolarSSL, no test certificate, `/dev/urandom` as random source.
        * `make`
 
 3. Install
@@ -30,6 +26,16 @@ Instructions for building from source
 
 A startup script can easily be created if you want to. Just copy an existing script and edit it to your liking.
 
+Contributors
+------------
+* [Antoine Bertin](https://github.com/Diaoul)
+* [tilman2](http://code.google.com/u/@UhZTSlBWAxNMWgU%3D/)
+* J Sisson - sisson.j ( AT ) gmail DOT com
+* [pierre.h](http://code.google.com/u/@VBRUQ1ZTAhNEXwJ9/)
+* [phr0z3nt04st](https://github.com/phr0z3nt04st)
+* [Troy C](https://github.com/troxor)
+
+Hope I didn't forget anyone... Please just send me a mail if you feel this is the case.
 
 Support/Contact/Documentation
 -----------------------------