fix address comparison
[umurmur.git] / README.md
index 5053364421d0596abc0eeb0798badba0d3e9e3dd..5f4a0d4cc10a2ee73dbd5eb0131a1292d3563788 100644 (file)
--- a/README.md
+++ b/README.md
@@ -11,15 +11,22 @@ Instructions for building from source
 1. Requirements
        * [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.
+       * [libprotoc-c](http://code.google.com/p/protobuf-c/) version 1.0.0 (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.
+  * [CMake](http://cmake.org) (optional)
 
-2. Build
-       * `./configure` - use `./configure --help` for switches. Defaults to build using PolarSSL, no test certificate, `/dev/urandom` as random source.
+2. Build - CMake
+       * Create a build folder and cd into it
+       * `cmake ../` to use default settings (polarssl, no test-cert and /dev/urandom as source for randomness).
        * `make`
 
+2. Build - Autotools
+       * Run `./autogen.sh`
+       * Run `./configure` for default settings
+       * `make`
+   
 3. Install
        * `make install`
-       * Edit umurmur.conf.example to your liking and put it in a suitable place. /etc/umurmur.conf is default.
+       * Edit the umurmur.conf found in the 'etc' folder in the prefix (eg. /usr/local) you installed to.
 
 4. Run `umurmurd -c <conf file> -p <PID file> -r`. For other switches and their meaning run `umurmurd -h`
 
@@ -33,6 +40,10 @@ Contributors
 * [pierre.h](http://code.google.com/u/@VBRUQ1ZTAhNEXwJ9/)
 * [phr0z3nt04st](https://github.com/phr0z3nt04st)
 * [Troy C](https://github.com/troxor)
+* [Trivve](https://github.com/Trivve)
+* [hasufell](https://github.com/hasufell)
+* [fmorgner](https://github.com/fmorgner)
+* [Rawi666](https://github.com/Rawi666)
 
 Hope I didn't forget anyone... Please just send me a mail if you feel this is the case.