Merge PR #60: Update README.

This commit is contained in:
Davide Beatrici 2020-04-12 01:01:36 +02:00 committed by GitHub
commit 362167ea3f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,7 +1,7 @@
Linux CI (Travis CI):
[![Build Status](https://travis-ci.com/mumble-voip/grumble.svg?branch=master)](https://travis-ci.org/mumble-voip/grumble)
[![Build Status](https://travis-ci.com/mumble-voip/grumble.svg?branch=master)](https://travis-ci.com/mumble-voip/grumble)
Windows CI (AppVeyor):
@ -23,18 +23,21 @@ https://golang.org/dl/
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
```shell script
$ export GOPATH=$HOME/gocode
$ mkdir -p $GOPATH
```
and on Windows, do something like this (for cmd.exe):
```shell script
c:\> set GOPATH=%USERPROFILE%\gocode
c:\> mkdir %GOPATH%
```
Then, it's time to install Grumble. The following line should do the trick:
```shell script
$ go get mumble.info/grumble/cmd/grumble
```
And that should be it. Grumble has been built, and is available in $GOPATH/bin as 'grumble'.
@ -61,23 +64,25 @@ Docker
## Getting the image
### Building
```shell script
$ git clone https://github.com/mumble-voip/grumble.git
$ cd grumble/
$ docker build -t mumble-voip/grumble .
```
## Running
### Command line
```shell script
$ docker run \
-v $HOME/.grumble:/data \
-p 64738:64738 \
-p 64738:64738/udp \
mumble-voip/grumble
```
### Compose
```yaml
version: '3'
services:
grumble:
@ -87,3 +92,4 @@ Docker
- 64738:64738/udp
volumes:
- $HOME/.grumble:/data
```