diff --git a/README b/README deleted file mode 100644 index 2dac789..0000000 --- a/README +++ /dev/null @@ -1,5 +0,0 @@ -What is Grumble? -================ - -Grumble is an implementation of Murmur (the server component of Mumble, an -open-source VoIP application) in the Go language. diff --git a/README.markdown b/README.markdown new file mode 100644 index 0000000..c9ae23c --- /dev/null +++ b/README.markdown @@ -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'. \ No newline at end of file