summaryrefslogtreecommitdiff
path: root/mpvc/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'mpvc/README.md')
-rw-r--r--mpvc/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/mpvc/README.md b/mpvc/README.md
new file mode 100644
index 0000000..7324b57
--- /dev/null
+++ b/mpvc/README.md
@@ -0,0 +1,14 @@
+# mpvc: remote control for a long-running mpv process
+
+This is what I use as a media player nowadays.
+To launch the long-running mpv, run `mpvc launch_mpv`.
+Typically I do that from a runit service, so the mpv runs from startup
+to shutdown.
+
+Commands are poorly documented. I use `click` for building the
+interface, so it is at least fairly discoverable.
+
+# Dependencies
+
+* Python 3.6+
+* [click](http://click.pocoo.org/). This is widely available in distros and ports trees. See its [page on repology.org](https://repology.org/project/python:click/versions) if you need help finding it.