Added build instructions to README

This commit is contained in:
Christian Muehlhaeuser 2017-08-29 07:23:35 +02:00
parent aef1c96106
commit dba819c755
No known key found for this signature in database
GPG key ID: BA4CF857DD4117E9

View file

@ -1,2 +1,25 @@
# Chirp!
Chirp!
======
A lightweight but modern Twitter client, written in Go & QML.
## Installation
Make sure you have a working Go environment. See the [install instructions](http://golang.org/doc/install.html).
### Dependencies
Before you can build Chirp you need to install the [Go/Qt bindings](https://github.com/therecipe/qt/wiki/Installation#regular-installation).
### Building Chirp!
git clone https://github.com/muesli/chirp.git
qtdeploy build desktop chirp/
### Run it
./chirp/deploy/linux/chirp
## Development
API docs can be found [here](http://godoc.org/github.com/muesli/chirp).