add default key bindings to README

[barnard.git] / README.md

diff --git a/README.md b/README.md
index 65098aca264f69ce1804877f5796ed7ef2ceea1d..4bfbdecc232aed72fdae752a06cedba26474732a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,15 +1,41 @@
 # 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.
 
 ![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`.
+
+## Manual
+
+### Key bindings
+
+- <kbd>F1</kbd>: toggle voice transmission
+- <kbd>Ctrl+L</kbd>: clear chat log
+- <kbd>Tab</kbd>: toggle focus between chat and user tree
+- <kbd>Page Up</kbd>: scroll chat up
+- <kbd>Page Down</kbd>: scroll chat down
+- <kbd>Home</kbd>: scroll chat to the top
+- <kbd>End</kbd>: scroll chat to the bottom
+- <kbd>F10</kbd>: quit
+
 ## License
 
-MPL 2.0
+GPLv2
 
 ## Author