ref: 63d962ecbca2b261d4cbf78f47fe415a97c38fd9
parent: ffe0c0231021825e2e942da02c58786215248ce3
author: Sigrid Haflínudóttir <[email protected]>
date: Thu Dec 5 12:28:45 EST 2019
readme.md
--- a/README
+++ /dev/null
@@ -1,29 +1,0 @@
-Building zuke requires libtags, which happens to reside on github
-currently, so:
-
-% cd /tmp
-% hget https://github.com/ftrvxmtrx/libtags/archive/master.tar.gz | tar xz
-% cd libtags-master/src
-% mk install
-
-Zuke comes with two programs. One is audio/zuke, which is the player
-itself. The other one is audio/mkplist, it's used to make playlists
-that are then fed to audio/zuke's stdin:
-
-% audio/mkplist /n/somefs/mymusic > $home/somefs.plist
-% audio/zuke < $home/somefs.plist
-
-Keys:
-left/right - seek backwards/forward
-up/down/pgup/pgdn/home/end - move within the playlist
-enter - play the selected track
-o - move to the currently playing track
-q/del - quit
-> - skip next
-< - skip prev
-s - stop
-p - pause/resume
-/ - search forward
-? - search backwards
-n - repeat search forward
-N - repeat search backwards
--- /dev/null
+++ b/README.md
@@ -1,0 +1,48 @@
+# zuke
+
+A music player for Plan 9.
+
+## Installing
+
+```
+cd /tmp && \
+hget https://github.com/ftrvxmtrx/libtags/archive/master.tar.gz | tar xz && \
+cd libtags-master/src && mk install && cd ../.. && \
+hget https://github.com/ftrvxmtrx/zuke/archive/master.tar.gz | tar xz && \
+cd zuke-master && mk install
+```
+
+Zuke comes with two programs. One is `audio/zuke`, which is the player
+itself. The other one is `audio/mkplist`, it's used to make playlists
+that are then fed to `audio/zuke`'s stdin:
+
+```
+% audio/mkplist /n/somefs/mymusic > $home/somefs.plist
+% audio/zuke < $home/somefs.plist
+```
+
+Of course, one can combine these steps into one:
+
+```
+% audio/mkplist /n/music | audio/zuke
+```
+
+## Hot keys
+
+```
+left/right - seek backwards/forward
+up/down/pgup/pgdn/home/end - move within the playlist
+o - move to the currently playing track
+enter - play the selected track
+
+> - skip next
+< - skip prev
+s - stop
+p - pause/resume
+q/del - quit
+
+/ - search forward
+? - search backwards
+n - repeat search forward
+N - repeat search backwards
+```