1
0
Fork 0
forked from External/grumble

Update README, use Markdown.

This commit is contained in:
Mikkel Krautz 2012-03-10 13:34:36 +01:00
parent dc303e6b1e
commit 5e38d0439a
2 changed files with 29 additions and 5 deletions

29
README.markdown Normal file
View file

@ -0,0 +1,29 @@
What is Grumble?
================
Grumble is an implementation of a server for the Mumble voice chat system. It is an alternative to Murmur, the typical Mumble server.
Compiling Grumble from source
=============================
You must have a Go 1 environment installed to build Grumble. Those are available at:
http://code.google.com/p/go/downloads/list
Once Go is installed, you should set up a GOPATH to avoid clobbering your Go environment's root directory with third party packages.
Set up a GOPATH. On Unix, do something like this
$ export GOPATH=$HOME/gocode
$ mkdir -p $GOPATH
and on Windows, do something like this (for cmd.exe):
c:\> set GOPATH=%USERPROFILE\gocode
c:\> mkdir %GOPATH%
Then, it's time to install Grumble. The following line should do the trick:
$ go get mumbleapp.com/grumble
And that should be it. Grumble has been built, and is available in $GOPATH/bin as 'grumble'.