From f3873da5ccb360dab54d7415e2c6ddf72538ec84 Mon Sep 17 00:00:00 2001 From: 9and3r <9and3r@gmail.com> Date: Sat, 2 Aug 2014 13:38:29 +0200 Subject: [PATCH] Update README.rst --- README.rst | 41 ++++++++++++++++++++++++++++++++--------- 1 file changed, 32 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index 46c9151..e129d13 100644 --- a/README.rst +++ b/README.rst @@ -18,7 +18,14 @@ Mopidy-Touchscreen :target: https://coveralls.io/r/9and3r/modipy-touchscreen?branch=master :alt: Test coverage -Mopidy extension to show info on a display and control from it +Extension for displaying track info and controlling Mopidy from a touch screen using `PyGame `_/SDL. + +Dependencies +============ + +- ``Mopidy`` >= 0.18 +- ``Pykka`` >= 1.1 +- ``pygame`` Installation ============ @@ -45,38 +52,49 @@ Mopidy-Touchscreen to your Mopidy configuration file:: fullscreen = False cache_dir = $XDG_CACHE_DIR/mopidy/touchscreen +The following configuration values are available: + +- ``touchscreen/enabled``: If the Touchscreen extension should be enabled or not. +- ``touchscreen/screen_width``: The width of the resolution you want to use in pixels. +- ``touchscreen/screen_height``: The width of the resolution you want to use in pixels. +- ``touchscreen/cursor``: If the mouse cursor should be shown. (If you use a touchscreen it should be false) +- ``touchscreen/fullscreen``: If you want to be shown as a window or in fullscreen. +- ``touchscreen/screen_width``: The folder to be used as cache. Defaults to ``$XDG_CACHE_DIR/mopidy/touchscreen``, which usually means + ``~/.cache/mopidy/spotify`` + Features ============= Working ------- +* See track info (track name, album, artist, cover image) * Seek Track * Play/Pause * Mute/Unmute * Change volume * Next/Previous track -* See track info (track name, album, artist, cover image) +* Library +* Menu (exit mopidy, restart...) * Shuffle on/off * Repeat one/on/off -* Playback list and control +* Playback list and song selection * Playlists Planned ------- -* Library -* Menu (exit mopidy, restart...) * Use keyboard or GPIO buttons instead of touchscreen Screenshots =========== -.. image:: http://i60.tinypic.com/i4l0fq.jpg +.. image:: http://i60.tinypic.com/qqsait.jpg -.. image:: http://i62.tinypic.com/nd7vk1.jpg -Extension running on -`Texy's display `_ +Video +===== + +`Example video running the extension `_ Project resources ================= @@ -89,6 +107,11 @@ Project resources Changelog ========= +v0.2.0 +---------------------------------------- + +- First working version + v0.1.0 (UNRELEASED) ----------------------------------------