2019-05-09 14:33:26 +00:00
|
|
|
Telephant!
|
2019-05-10 15:23:22 +00:00
|
|
|
==========
|
2017-08-29 05:23:35 +00:00
|
|
|
|
2019-05-11 03:34:16 +00:00
|
|
|
A lightweight but modern Mastodon client, written in Go & QML.
|
2017-08-29 05:23:35 +00:00
|
|
|
|
2019-05-10 18:19:25 +00:00
|
|
|
|
2017-08-29 09:55:57 +00:00
|
|
|
|
2017-08-29 05:40:25 +00:00
|
|
|
## Features
|
|
|
|
|
|
2019-05-01 15:15:56 +00:00
|
|
|
- [x] Live feed via Mastodon's Streaming API
|
2017-08-29 05:40:25 +00:00
|
|
|
- [x] Multi pane support
|
2017-08-29 11:14:53 +00:00
|
|
|
- [x] Linux/macOS/Windows (Android & iOS should be working, but aren't tested yet)
|
2017-08-30 23:32:06 +00:00
|
|
|
- [x] Media previews
|
2017-08-31 21:53:44 +00:00
|
|
|
- [x] Shortened URL resolving
|
2017-08-29 05:56:24 +00:00
|
|
|
- [ ] System notifications
|
2019-05-01 15:15:56 +00:00
|
|
|
- [ ] Multiple accounts (work-in-progress)
|
|
|
|
|
- [ ] Support for more networks
|
2017-08-29 05:40:25 +00:00
|
|
|
|
2017-08-29 05:23:35 +00:00
|
|
|
## Installation
|
|
|
|
|
|
2019-05-10 22:20:19 +00:00
|
|
|
### Packages & Installers
|
|
|
|
|
|
2019-05-12 19:21:46 +00:00
|
|
|
- [Windows 64bit](https://github.com/muesli/telephant/releases/download/v0.1/telephant_0.1pre_Windows_64bit.exe)
|
2019-05-11 23:51:41 +00:00
|
|
|
- [Linux Static 64bit](https://github.com/muesli/telephant/releases/download/v0.1/telephant_0.1pre_Linux_64bit)
|
2019-05-10 22:20:19 +00:00
|
|
|
|
|
|
|
|
### From Source
|
|
|
|
|
|
2019-05-14 01:02:04 +00:00
|
|
|
Make sure you have a working Go environment (Go 1.9 or higher is required).
|
2018-01-22 06:12:15 +00:00
|
|
|
See the [install instructions](http://golang.org/doc/install.html).
|
2017-08-29 05:23:35 +00:00
|
|
|
|
2019-05-11 16:57:01 +00:00
|
|
|
You will also need Qt5 and its development headers installed.
|
|
|
|
|
|
2019-05-10 22:20:19 +00:00
|
|
|
#### Dependencies
|
2017-08-29 05:23:35 +00:00
|
|
|
|
2019-05-09 14:33:26 +00:00
|
|
|
Before you can build Telephant you need to install the [Go/Qt bindings](https://github.com/therecipe/qt/wiki/Installation#regular-installation).
|
2017-08-29 05:23:35 +00:00
|
|
|
|
2019-05-12 01:22:24 +00:00
|
|
|
#### Qt5 dependencies (Ubuntu example)
|
|
|
|
|
|
|
|
|
|
apt-get --no-install-recommends install build-essential libglib2.0-dev libglu1-mesa-dev libpulse-dev
|
|
|
|
|
apt-get --no-install-recommends install libqt*5-dev qt*5-dev qt*5-doc-html qml-module-qtquick*
|
|
|
|
|
|
|
|
|
|
#### Qt Bindings
|
|
|
|
|
|
2019-05-10 20:03:59 +00:00
|
|
|
export QT_PKG_CONFIG=true
|
2019-05-10 15:23:22 +00:00
|
|
|
go get -u -v github.com/therecipe/qt/cmd/...
|
2019-05-11 19:42:40 +00:00
|
|
|
$(go env GOPATH)/bin/qtsetup -test=false
|
2017-08-29 05:23:35 +00:00
|
|
|
|
2019-05-10 22:20:19 +00:00
|
|
|
#### Building Telephant
|
2017-08-29 05:23:35 +00:00
|
|
|
|
2019-05-12 15:56:31 +00:00
|
|
|
go get -d -u -v github.com/muesli/telephant
|
|
|
|
|
cd $(go env GOPATH)/src/github.com/muesli/telephant
|
2019-05-10 16:16:58 +00:00
|
|
|
$(go env GOPATH)/bin/qtdeploy build desktop .
|
2017-08-29 05:23:35 +00:00
|
|
|
|
2019-05-12 01:25:54 +00:00
|
|
|
#### Within a Docker container
|
2019-05-11 03:34:16 +00:00
|
|
|
|
|
|
|
|
Follow the build instructions above, but instead of the last command, run:
|
|
|
|
|
|
|
|
|
|
$(go env GOPATH)/bin/qtdeploy -docker build linux
|
|
|
|
|
|
2019-05-10 22:20:19 +00:00
|
|
|
#### Run it
|
2017-08-29 05:23:35 +00:00
|
|
|
|
2019-05-10 16:16:58 +00:00
|
|
|
./deploy/linux/telephant
|
2017-08-29 14:08:44 +00:00
|
|
|
|
2019-05-10 18:19:25 +00:00
|
|
|
|
|
|
|
|
|
2017-08-29 05:23:35 +00:00
|
|
|
## Development
|
|
|
|
|
|
2019-05-09 14:33:26 +00:00
|
|
|
[](https://godoc.org/github.com/muesli/telephant)
|
|
|
|
|
[](https://travis-ci.org/muesli/telephant)
|
|
|
|
|
[](http://goreportcard.com/report/muesli/telephant)
|
