README.md

   1 # barnard
   2
   3 barnard is a terminal-based client for the [Mumble](https://mumble.info) voice
   4 chat software.
   5
   6 ![Screenshot](https://i.imgur.com/B8ldT5k.png)
   7
   8 ## Installation
   9
  10 Requirements:
  11
  12 1. [Go](https://golang.org/)
  13 2. [Git](https://git-scm.com/)
  14 3. [Opus](https://opus-codec.org/) development headers
  15 4. [OpenAL](http://kcat.strangesoft.net/openal.html) development headers
  16
  17 To fetch and build:
  18
  19     go get -u layeh.com/barnard
  20
  21 After running the command above, `barnard` will be compiled as `$(go env GOPATH)/bin/barnard`.
  22
  23 ## Manual
  24
  25 ### Key bindings
  26
  27 - <kbd>F1</kbd>: toggle voice transmission
  28 - <kbd>Ctrl+L</kbd>: clear chat log
  29 - <kbd>Tab</kbd>: toggle focus between chat and user tree
  30 - <kbd>Page Up</kbd>: scroll chat up
  31 - <kbd>Page Down</kbd>: scroll chat down
  32 - <kbd>Home</kbd>: scroll chat to the top
  33 - <kbd>End</kbd>: scroll chat to the bottom
  34 - <kbd>F10</kbd>: quit
  35
  36 ## License
  37
  38 GPLv2
  39
  40 ## Author
  41
  42 Tim Cooper (<tim.cooper@layeh.com>)