From 8ec525fa6bfa5e6fa46e391bb772a2c5e41d1430 Mon Sep 17 00:00:00 2001 From: Fabian Date: Fri, 20 May 2016 10:22:21 +0200 Subject: [PATCH 1/5] Added installation and usage instructions --- README.md | 34 ++++++++++++++++++++++++++++++++-- 1 file changed, 32 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 435f3cf..8f32bd0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,33 @@ -# toon +# Toon -add description of toon here \ No newline at end of file +The SoundCloud based interactive radio station + +--- + +## Installation + +Toon uses `mpd` (music player daemon) to stream audio in a headless manner. + +``` +$ brew install mpd toon +``` + +## Usage + +``` +$ mpd --no-config + +$ toon +``` + +Controls (Vim style): + +`h` - previous + +`j` - pause + +`k` - play + +`l` - next + +`r` - enter track URL From a9137bc3a063ff21a233a0944100de7cb29fa71c Mon Sep 17 00:00:00 2001 From: Fabian Date: Fri, 20 May 2016 11:25:02 +0200 Subject: [PATCH 2/5] Update README.md --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8f32bd0..d9fbf83 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,19 @@ The SoundCloud based interactive radio station ---- - ## Installation Toon uses `mpd` (music player daemon) to stream audio in a headless manner. ``` +$ brew tap yemi/toon $ brew install mpd toon ``` ## Usage ``` -$ mpd --no-config +$ mpd --no-config # runs the mpd server $ toon ``` From 637c6e3466019761a1b4ed972da328cae43a4eda Mon Sep 17 00:00:00 2001 From: Fabian Date: Fri, 20 May 2016 11:27:29 +0200 Subject: [PATCH 3/5] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d9fbf83..364fd92 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,14 @@ The SoundCloud based interactive radio station Toon uses `mpd` (music player daemon) to stream audio in a headless manner. -``` +```shell $ brew tap yemi/toon $ brew install mpd toon ``` ## Usage -``` +```shell $ mpd --no-config # runs the mpd server $ toon From 68681f2d9a53f630c7ae0d686cd32a0f4f61c85e Mon Sep 17 00:00:00 2001 From: Fabian Date: Fri, 20 May 2016 11:27:59 +0200 Subject: [PATCH 4/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 364fd92..a9ccf82 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ $ brew install mpd toon ## Usage ```shell -$ mpd --no-config # runs the mpd server +$ mpd --no-config # runs the mpd server that toon interacts with $ toon ``` From 6f7516beac6707b5b5bb9f69ba6ed64c3760cb4d Mon Sep 17 00:00:00 2001 From: Fabian Date: Fri, 20 May 2016 11:28:48 +0200 Subject: [PATCH 5/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a9ccf82..e97bc83 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Toon -The SoundCloud based interactive radio station +Interactive radio station based on SoundCloud ## Installation