telephant/README.md
2019-06-02 15:50:13 +02:00

2.3 KiB

Telephant!

A lightweight but modern Mastodon client, written in Go & QML.

telephant logo

Features

  • Live feed via Mastodon's Streaming API
  • Multi pane support
  • Linux/macOS/Windows (Android & iOS should be working, but aren't tested yet)
  • Media previews
  • Shortened URL resolving
  • System notifications
  • Multiple accounts (work-in-progress)
  • Support for more networks

Installation

Packages & Installers

From Source

Make sure you have a working Go environment (Go 1.9 or higher is required). See the install instructions.

You will also need Qt5 and its development headers installed.

Dependencies

Before you can build Telephant you need to install the Go/Qt bindings.

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*

Building Telephant

export QT_PKG_CONFIG=true
go get -u -v -tags=no_env github.com/therecipe/qt/cmd/...
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 .

Within a Docker container

Follow the build instructions above, but instead of the last command, run:

$(go env GOPATH)/bin/qtdeploy -docker build linux

Run it

./deploy/linux/telephant

telephant Screenshot

Development

GoDoc Build Status Go ReportCard