diff options
| author | Florrie <towerofnix@gmail.com> | 2018-06-13 00:00:14 -0300 |
|---|---|---|
| committer | Florrie <towerofnix@gmail.com> | 2018-06-13 00:00:14 -0300 |
| commit | 70f43924bfaf138c81e355f1acc2dfd2d4348a80 (patch) | |
| tree | 851930e0e7148aea85d1c5915fe498185597ae19 | |
| parent | 5b21b38bf5358d40e37de83260a3b9298380c782 (diff) | |
Installation docs
| -rw-r--r-- | README.md | 17 |
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 @@  -## 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 |