Merge pull request #100 from C4K3/scheduler-timing
[umurmur.git] / README.md
index fe8dd5c390cad1e133e2455145b6a71dfd8c7c3b..707a4798b2dce019f06b29d2104c15a9ff1760e3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,41 +1,30 @@
-uMurmur - minimalistic Mumble server
-====================================
-Project page on [GoogleCode](http://code.google.com/p/umurmur/)
+#About 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
-       * [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`
-       * `make`
-
-3. Install
-       * `make install`
-       * Edit umurmur.conf.example to your liking and put it in a suitable place. /etc/umurmur.conf is default.
-
-4. Run `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 existing script and edit it to your liking.
+[Build instructions](https://github.com/umurmur/umurmur/wiki/Building) can be found in the [wiki](https://github.com/umurmur/umurmur/wiki).
 
 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)
+* [Trivve](https://github.com/Trivve)
+* [hasufell](https://github.com/hasufell)
+* [fmorgner](https://github.com/fmorgner)
+* [Rawi666](https://github.com/Rawi666)
+* [snowblind](https://github.com/snowblind)
+* [c4k3](https://github.com/C4K3)
 
 Hope I didn't forget anyone... Please just send me a mail if you feel this is the case.
 
 Support/Contact/Documentation
 -----------------------------
-See the project page, link above.
+Please consult the [wiki](https://github.com/umurmur/umurmur/wiki) and use the [issue tracker](https://github.com/umurmur/umurmur/issues) to report problems with uMurmur or to submit feature requests.
 
 Have fun!