add installation instructions
authorTim Cooper <tim.cooper@layeh.com>
Tue, 8 May 2018 21:11:01 +0000 (18:11 -0300)
committerTim Cooper <tim.cooper@layeh.com>
Tue, 8 May 2018 21:11:01 +0000 (18:11 -0300)
fixes #6

README.md

index e12a62b..5b71aa2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,8 +5,21 @@ chat software.
 
 ![Screenshot](https://i.imgur.com/B8ldT5k.png)
 
+## Installation
+
+Requirements:
+
+1. [Go](https://golang.org/)
+2. [Git](https://git-scm.com/)
+3. [Opus](https://opus-codec.org/) development headers
+4. [OpenAL](http://kcat.strangesoft.net/openal.html) development headers
+
+To fetch and build:
+
     go get -u layeh.com/barnard
 
+After running the command above, `barnard` will be compiled as `$(go env GOPATH)/bin/barnard`.
+
 ## License
 
 GPLv2