Febbweiss/mopidy-touchscreen
1
0
Fork 0
mirror of https://github.com/Febbweiss/mopidy-touchscreen.git synced 2026-03-04 22:25:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Wrap long lines, separate sections

Browse Source
This commit is contained in:
Stein Magnus Jodal
2015-03-24 12:03:37 +01:00
parent a21d977255
commit f8b3c3fb63
1 changed files with 32 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
README.rst
View File

@@ -18,10 +18,12 @@ Mopidy-Touchscreen
:target: https://coveralls.io/r/9and3r/mopidy-touchscreen?branch=master
:alt: Test coverage
Extension for displaying track info and controlling Mopidy from a touch screen using `PyGame <http://www.pygame.org/>`_/SDL.
Extension for displaying track info and controlling Mopidy from a touch screen
using `PyGame <http://www.pygame.org/>`_/SDL.
Cover images are downloaded from `last.fm <http://www.last.fm/api>`_
Dependencies
============
@@ -29,6 +31,7 @@ Dependencies
- ``Pykka`` >= 1.1
- ``pygame``
Installation
============
@@ -56,12 +59,23 @@ Mopidy-Touchscreen to your Mopidy configuration file::
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
- ``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/touchscreen``
@@ -92,7 +106,7 @@ To find your values find an example of using pygame with your LCD Shield and it
os.environ["SDL_MOUSEDRV"] = "TSLIB"
os.environ["SDL_MOUSEDEV"] = "event0"
Run mopidy with root privileges
Run Mopidy with root privileges
```````````````````````````````
You can use ``sudo mopidy``.
@@ -108,6 +122,7 @@ Help
You can use `mopidy discuss <https://discuss.mopidy.com/>`_
or send an email to `9and3r@gmail.com <mailto:9and3r@gmail.com>`_
Features
========
@@ -132,16 +147,19 @@ Planned
* Use keyboard or GPIO buttons instead of touchscreen
Screenshots
===========
.. image:: http://i60.tinypic.com/qqsait.jpg
Video
=====
`Example video running the extension <https://www.youtube.com/watch?v=KuYoIb8Q2LI>`_
Project resources
=================