« get me outta code hell

mtui - Music Text User Interface - user-friendly command line music player
about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
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
 
 * <kbd><kbd>Ctrl</kbd>+<kbd>C</kbd></kbd> - exit
 * <kbd>Up</kbd> and <kbd>Down</kbd> - select previous or next item in a listing