mirror of
https://github.com/muesli/telephant
synced 2024-09-20 06:01:54 +00:00
81 lines
3.1 KiB
Markdown
81 lines
3.1 KiB
Markdown
Telephant
|
|
=========
|
|
|
|
[](https://github.com/muesli/telephant/releases)
|
|
[](https://godoc.org/github.com/muesli/telephant)
|
|
[](https://travis-ci.org/muesli/telephant)
|
|
[](http://goreportcard.com/report/muesli/telephant)
|
|
|
|
A lightweight but modern Mastodon client for the desktop, written in Go & QML.
|
|
|
|
|
|
|
|
## Features
|
|
|
|
- [x] Live feed via Mastodon's Streaming API
|
|
- [x] Multi pane support
|
|
- [x] Linux/macOS/Windows (Android & iOS should be working, but aren't tested yet)
|
|
- [x] Media previews
|
|
- [x] Shortened URL resolving
|
|
- [x] System notifications
|
|
- [ ] Direct messages
|
|
- [ ] Multiple accounts (work-in-progress)
|
|
- [ ] Support for more networks
|
|
|
|
## Installation
|
|
|
|
### Packages & Binaries
|
|
|
|
- Arch Linux: [telephant-git](https://aur.archlinux.org/packages/telephant-git/)
|
|
- [Ubuntu 64bit Binary](https://github.com/muesli/telephant/releases/download/v0.1-rc3/telephant_0.1rc3_Ubuntu_64bit)
|
|
- [Linux Static 64bit Binary](https://github.com/muesli/telephant/releases/download/v0.1-rc3/telephant_0.1rc3_Linux_64bit)
|
|
- [Windows 64bit Binary](https://github.com/muesli/telephant/releases/download/v0.1-rc3/telephant_0.1rc3_Windows_64bit.exe)
|
|
|
|
#### Ubuntu
|
|
|
|
Note that `Telephant` requires Qt >=5.12 installed. This means it currently
|
|
doesn't support Ubuntu <19.04 or Linux Mint.
|
|
|
|
You need to install the following dependencies to run the Ubuntu binary:
|
|
|
|
```bash
|
|
apt install libqt5gui5 libqt5qml5 libqt5quickcontrols2-5 libqt5multimedia5-plugins \
|
|
qml-module-qtquick2 qml-module-qtmultimedia qml-module-qtquick-layouts \
|
|
qml-module-qtquick-controls qml-module-qtquick-controls2 \
|
|
qml-module-qtquick-window2 qml-module-qtgraphicaleffects \
|
|
qml-module-qtquick-dialogs qml-module-qt-labs-folderlistmodel \
|
|
qml-module-qt-labs-settings
|
|
```
|
|
|
|
### From Source
|
|
|
|
Make sure you have a working Go environment (Go 1.9 or higher is required).
|
|
See the [install instructions](http://golang.org/doc/install.html).
|
|
|
|
You will also need Qt5 >=5.12 and its development headers installed.
|
|
|
|
#### Dependencies (Ubuntu example)
|
|
|
|
apt-get --no-install-recommends install build-essential git 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*
|
|
apt-get install qml-module-qtmultimedia qml-module-qt-labs-folderlistmodel qml-module-qt-labs-settings
|
|
|
|
#### 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
|
|
|
|
|