README update. Now using Markdown syntax

diff --git a/README b/README
deleted file mode 100644 (file)
index f56ef6b..0000000
--- a/README
+++ /dev/null
@@ -1,45 +0,0 @@
-README for uMurmur - minimalistic Mumble server
-===============================================
-http://code.google.com/p/umurmur/
-
-uMurmur 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 subdirectory suitable for buildning 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.
-
-
-Instructions for building from source:
-1. Requirements
-o OpenSSL or PolarSSL library
-o libconfig
-o libprotoc-c (use --disable-protoc option in its ./configure)
-
-2. Build
-o ./configure
-o make
-
-3. Install
-o make install
-o Edit umurmur.conf.example to your liking and put it in a suitable place.
-  /etc/umurmur.conf is default.
-
-4. Run
-As daemon:
-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.
-
-5. Support/Contact/Documentation
-See the project page, link above.
-
-Have fun!

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..e3f7efb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+uMurmur - minimalistic Mumble server
+====================================
+Hosted on [GitHub](https://github.com/fatbob313/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.
+
+
+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 (use --disable-protoc option in its ./configure)
+
+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.
+
+
+Support/Contact/Documentation
+-----------------------------
+See the project page, link above.
+
+Have fun!