From: Felix Morgner Date: Mon, 6 Jul 2015 12:39:54 +0000 (+0200) Subject: updated README X-Git-Url: http://git.code-monkey.de/?p=umurmur.git;a=commitdiff_plain;h=f894ca6650867e0f21c3f471acb0eefb5c14f2a1 updated README --- diff --git a/README.md b/README.md index 828b061..e037d59 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,10 @@ -uMurmur - minimalistic Mumble server -==================================== -Project page on [GoogleCode](http://code.google.com/p/umurmur/) +#About 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. 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 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 - 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 the umurmur.conf found in the 'etc' folder in the prefix (eg. /usr/local) you installed to. - -4. Run `umurmurd -c -p -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 ------------ @@ -48,6 +24,6 @@ Hope I didn't forget anyone... Please just send me a mail if you feel this is th 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!