Merge lp:~alfonsosanchezbeato/media-hub/initial-docs into lp:media-hub

Proposed by Alfonso Sanchez-Beato
Status: Merged
Approved by: Jim Hodapp
Approved revision: 215
Merged at revision: 215
Proposed branch: lp:~alfonsosanchezbeato/media-hub/initial-docs
Merge into: lp:media-hub
Diff against target: 44 lines (+39/-0)
1 file modified
docs/index.md (+39/-0)
To merge this branch: bzr merge lp:~alfonsosanchezbeato/media-hub/initial-docs
Reviewer Review Type Date Requested Status
Jim Hodapp (community) Approve
Review via email: mp+320223@code.launchpad.net

Commit message

Initial documentation for media-hub snap.

Description of the change

Initial documentation for media-hub snap.

To post a comment you must log in.
Revision history for this message
Jim Hodapp (jhodapp) wrote :

Looks good, some things to fix inline below.

review: Needs Fixing
Revision history for this message
Alfonso Sanchez-Beato (alfonsosanchezbeato) :
215. By Alfonso Sanchez-Beato

Address review comments

Revision history for this message
Alfonso Sanchez-Beato (alfonsosanchezbeato) wrote :

@jhodapp, thanks for the review. Comments addressed and branch refreshed.

Revision history for this message
Jim Hodapp (jhodapp) wrote :

LGTM

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== added directory 'docs'
2=== added file 'docs/index.md'
3--- docs/index.md 1970-01-01 00:00:00 +0000
4+++ docs/index.md 2017-03-21 09:09:53 +0000
5@@ -0,0 +1,39 @@
6+---
7+title: "Media Hub"
8+table_of_contents: False
9+---
10+
11+# About Media Hub
12+
13+Media Hub is a simple and lightweight media playback service. It implements the
14+[MPRIS DBus
15+interface](https://specifications.freedesktop.org/mpris-spec/latest/) and plays
16+audio and video files. Among other features, it supports:
17+
18+ * Centralized system media playback and control
19+ * Track lists
20+ * Various simultaneous clients
21+ * Hardware video decoding
22+
23+## Installing Media Hub
24+
25+It can be installed as a snap doing
26+
27+```text
28+$ snap install media-hub
29+```
30+
31+## Using Media Hub
32+
33+It can be used jointly with mediaplayer-app. To install this client:
34+
35+```text
36+$ snap install --devmode mediaplayer-app
37+$ snap connect mediaplayer-app:mpris media-hub:mpris
38+```
39+
40+After this, files in Music or Videos folders can be played:
41+
42+```text
43+$ mediaplayer-app Music/file.mp3
44+```

Subscribers

People subscribed via source and target branches