Alexander/gomuks
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Tulir Asokan 2018-03-15 21:53:50 +02:00 committed by GitHub
parent f1b0526977
commit e69e494a52
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,4 +1,15 @@
# gomuks # gomuks
A terminal Matrix client written in Go. A terminal Matrix client written in Go using [gomatrix](https://github.com/matrix-org/gomatrix) and [tview](https://github.com/rivo/tview).
Not yet actually usable, though receiving and sending messages works. Very basic usage is possible, but many of the features you'd expect from a
Matrix client (like chat history) haven't been implemented.
## Installation
Once the client becomes actually usable, I'll start making GitHub releases with
precompiled executables and maybe even some Linux packages.
For now, you'll have to compile from source:
0. Install [Go](https://golang.org/)
1. Run `go get -u maunium.net/go/gomuks`
2. gomuks should now be in `$GOPATH/bin/gomuks`