add installation instructions

[barnard.git] / README.md

diff --git a/README.md b/README.md
index 259fb22ce5e52e648789dcf812e2576ff010ca91..5b71aa29e36e2ba9201f8367258c69d6faf9f6d9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,13 +1,28 @@
 # barnard
 
-barnard is a terminal-based client for the [Mumble](http://mumble.info) voice
+barnard is a terminal-based client for the [Mumble](https://mumble.info) voice
 chat software.
 
-## Requirements
+![Screenshot](https://i.imgur.com/B8ldT5k.png)
 
-- [gumble](https://github.com/layeh/gumble/tree/master/gumble)
-- [gumble_openal](https://github.com/layeh/gumble/tree/master/gumble_openal)
-- [termbox-go](https://github.com/nsf/termbox-go)
+## 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
 
 ## Author