add readme instatructions

This commit is contained in:
Jonas Weinz 2021-07-04 13:53:24 +02:00
parent 85176956ab
commit 6c7d9dee3c
3 changed files with 33 additions and 2 deletions

View File

@ -1,3 +1,34 @@
# mediathek-viewer # gtk-mediathek-player
very simple python mediathek viewer for GNOME (using https://mediathekviewweb.de/'s API for search requests).
![player widget](readme_images/player.jpeg)
![search](readme_images/search.jpeg)
## Installation
tested on ubuntu 21.04
**dependencies**
```bash
sudo apt install python3-pip gstreamer1.0-plugins-bad
```
**install directly from the git repository**
```
pip3 install --user git+https://the-cake-is-a-lie.net/gogs/jonas/mediathek-viewer.git
```
if the package is installed user or system wide, there should exist a new start menu entry after installation. Otherwise the program can be started manually with:
```bash
python3 -m gtk_mediathek_player.main
```
mediathek viewer written in python

BIN
readme_images/player.jpeg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 830 KiB

BIN
readme_images/search.jpeg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 104 KiB