aboutsummaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2015-12-04 22:18:44 +1300
committerTom Ryder <tom@sanctum.geek.nz>2015-12-04 22:20:58 +1300
commit429db356903983bb464028f6292a801a1483c178 (patch)
treedfe8c037eb1749a4a9e840e7ead13c150c331bc7 /README.markdown
downloadmpdlrc-429db356903983bb464028f6292a801a1483c178.tar.gz
mpdlrc-429db356903983bb464028f6292a801a1483c178.zip
First commit
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..2780efb
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,25 @@
+mpdlrc
+======
+
+Print timed lyrics from an LRC file for MPD's currently playing song
+line-by-line to `stdout`: <https://en.wikipedia.org/wiki/LRC_%28file_format%29>
+
+Expects to find lyrics named `Artist - Title.lrc` in `~/.lyrics`.
+
+This code is not great. It will be improved. It needs to be more configurable
+from environment variables or options, for one thing.
+
+This could maybe be used with `dzen` or a similar desktop notification tool to
+display lyrics in a corner as you work on other things.
+
+An LRC file I made for Darkthrone's "To Walk The Infernal Fields" from their
+1993 album "Under a Funeral Moon" is included for testing.
+
+License
+-------
+
+Copyright (c) [Tom Ryder][1]. Distributed under [Artistic License 2.0][2].
+
+[1]: https://sanctum.geek.nz/
+[2]: http://opensource.org/licenses/artistic-license-2.0
+