From 70f43924bfaf138c81e355f1acc2dfd2d4348a80 Mon Sep 17 00:00:00 2001 From: Florrie Date: Wed, 13 Jun 2018 00:00:14 -0300 Subject: Installation docs --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index c9df579..31aab66 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,21 @@ ![Screenshot of the player](screenshot.png) -## keybindings +## Installation + +You will need a relatively recent version of [Node.js](https://nodejs.org/en/). + +``` +git clone https://git.ed1.club/florrie/mtui.git +cd mtui +npm install +npm link # Or sudo npm link +mtui # Or node . +``` + +Add music to the `~/Music` folder to make it show up in mtui, or pass `mtui` a +playlist.json file (usually generated by http-music or downloaded from online). + +## Keybindings * Ctrl+C - exit * Up and Down - select previous or next item in a listing -- cgit 1.3.0-6-gf8a5