telephant/README.md

68 lines
2.3 KiB
Markdown
Raw Normal View History

2019-05-09 16:33:26 +02:00
Telephant!
2019-05-10 17:23:22 +02:00
==========
2017-08-29 07:23:35 +02:00
A lightweight but modern Mastodon client, written in Go & QML.
2017-08-29 07:23:35 +02:00
2019-05-10 20:19:25 +02:00
![telephant logo](/assets/telephant.png)
2017-08-29 11:55:57 +02:00
2017-08-29 07:40:25 +02:00
## Features
2019-05-01 17:15:56 +02:00
- [x] Live feed via Mastodon's Streaming API
2017-08-29 07:40:25 +02:00
- [x] Multi pane support
- [x] Linux/macOS/Windows (Android & iOS should be working, but aren't tested yet)
- [x] Media previews
2017-08-31 23:53:44 +02:00
- [x] Shortened URL resolving
2019-06-02 15:50:13 +02:00
- [x] System notifications
2019-05-01 17:15:56 +02:00
- [ ] Multiple accounts (work-in-progress)
- [ ] Support for more networks
2017-08-29 07:40:25 +02:00
2017-08-29 07:23:35 +02:00
## Installation
2019-05-11 00:20:19 +02:00
### Packages & Installers
2019-05-27 10:40:15 +02:00
- Arch Linux: [telephant-git](https://aur.archlinux.org/packages/telephant-git/)
2019-05-12 01:51:41 +02:00
- [Linux Static 64bit](https://github.com/muesli/telephant/releases/download/v0.1/telephant_0.1pre_Linux_64bit)
- [Windows 64bit](https://github.com/muesli/telephant/releases/download/v0.1/telephant_0.1pre_Windows_64bit.exe)
2019-05-11 00:20:19 +02:00
### From Source
2019-05-14 03:02:04 +02:00
Make sure you have a working Go environment (Go 1.9 or higher is required).
2018-01-22 07:12:15 +01:00
See the [install instructions](http://golang.org/doc/install.html).
2017-08-29 07:23:35 +02:00
You will also need Qt5 and its development headers installed.
2019-05-11 00:20:19 +02:00
#### Dependencies
2017-08-29 07:23:35 +02:00
2019-05-09 16:33:26 +02: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 07:23:35 +02: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*
2019-05-11 00:20:19 +02:00
#### Building Telephant
2017-08-29 07:23:35 +02:00
export QT_PKG_CONFIG=true
go get -u -v -tags=no_env github.com/therecipe/qt/cmd/...
2019-05-12 17:56:31 +02:00
go get -d -u -v github.com/muesli/telephant
cd $(go env GOPATH)/src/github.com/muesli/telephant
$(go env GOPATH)/bin/qtdeploy build desktop .
2017-08-29 07:23:35 +02:00
#### Within a Docker container
Follow the build instructions above, but instead of the last command, run:
$(go env GOPATH)/bin/qtdeploy -docker build linux
2019-05-11 00:20:19 +02:00
#### Run it
2017-08-29 07:23:35 +02:00
./deploy/linux/telephant
2017-08-29 16:08:44 +02:00
2019-05-10 20:19:25 +02:00
![telephant Screenshot](/assets/screenshot.png)
2017-08-29 07:23:35 +02:00
## Development
2019-05-09 16:33:26 +02:00
[![GoDoc](https://godoc.org/github.com/golang/gddo?status.svg)](https://godoc.org/github.com/muesli/telephant)
[![Build Status](https://travis-ci.org/muesli/telephant.svg?branch=master)](https://travis-ci.org/muesli/telephant)
[![Go ReportCard](http://goreportcard.com/badge/muesli/telephant)](http://goreportcard.com/report/muesli/telephant)