Merge pull request #25 from fmorgner/ipv4

[umurmur.git] / README.md

diff --git a/README.md b/README.md
index fe8dd5c390cad1e133e2455145b6a71dfd8c7c3b..29610ef2226b867a4f08bfbbbaa033f98d712f06 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,17 +4,18 @@ Project page on [GoogleCode](http://code.google.com/p/umurmur/)
 
 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 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.
+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 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
@@ -29,8 +30,10 @@ Contributors
 ------------
 * [Antoine Bertin](https://github.com/Diaoul)
 * [tilman2](http://code.google.com/u/@UhZTSlBWAxNMWgU%3D/)
-* J Sisson - <sisson.j ( AT ) gmail DOT com>
+* 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.