telephant/README.md

64 lines
1.8 KiB
Markdown
Raw Normal View History

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
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
![telephant logo](/assets/telephant.png)
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
- [x] Linux/macOS/Windows (Android & iOS should be working, but aren't tested yet)
- [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
- [Windows 64bit](https://github.com/muesli/telephant/releases/download/v0.1/telephant.exe)
### From Source
2018-01-22 06:12:15 +00:00
Make sure you have a working Go environment (Go 1.8 or higher is required).
See the [install instructions](http://golang.org/doc/install.html).
2017-08-29 05:23:35 +00:00
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
export QT_PKG_CONFIG=true
2019-05-10 15:23:22 +00:00
go get -u -v github.com/therecipe/qt/cmd/...
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
mkdir -p $(go env GOPATH)/src/github.com/muesli
cd $(go env GOPATH)/src/github.com/muesli
git clone https://github.com/muesli/telephant.git
cd telephant
go get -u -v
$(go env GOPATH)/bin/qtdeploy build desktop .
2017-08-29 05:23:35 +00: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-10 22:20:19 +00:00
#### Run it
2017-08-29 05:23:35 +00:00
./deploy/linux/telephant
2017-08-29 14:08:44 +00:00
2019-05-10 18:19:25 +00:00
![telephant Screenshot](/assets/screenshot.png)
2017-08-29 05:23:35 +00:00
## Development
2019-05-09 14:33:26 +00: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)