summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdrian C. (anrxc) <anrxc@sysphere.org>2010-10-20 01:45:48 (GMT)
committerAdrian C. (anrxc) <anrxc@sysphere.org>2010-10-20 01:45:48 (GMT)
commit1d9768214922915e21b3304587d8f4b41ce22faa (patch)
treeabfb3028f00d75b8b23dc4e1b4770e76116e37eb
parent69bdd9e8fddc9e0e08e917dbc786fc4500599b92 (diff)
downloadplay-1d9768214922915e21b3304587d8f4b41ce22faa.tar.xz
README: added basic project information
-rw-r--r--README35
1 files changed, 35 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..b0d29ec
--- /dev/null
+++ b/README
@@ -0,0 +1,35 @@
+Description:
+
+ play is a curses front-end for various audio players, based on
+ cplay. It aims to provide a power-user-friendly interface with
+ simple filelist and playlist control. play is written in
+ Python and can use either pyncurses or the standard curses
+ module.
+
+Usage:
+
+ play [-nrRv] [ file | dir | playlist | url ] ...
+
+ When in doubt, press 'h' for a friendly help page.
+
+Miscellaneous:
+
+ In order for either mp3info (ID3) or ogginfo to work, both
+ corresponding python modules have to be installed. However,
+ quick support for MP3 tags can be added by getting 'ID3.py'
+ from the id3-py project: http://id3-py.sourceforge.net/
+
+ A playlist can contain URLs, but the playlist itself will have
+ to be local. For mpeg streaming, splay is recommended.
+
+ It is also possible to pipe a playlist to play, as stdin will
+ be reopened on startup unless it is attached to a tty.
+
+ Remote control is available through /tmp/play-control-$USER.
+
+Authors:
+
+ play is being maintained by Adrian C. After waiting over 2
+ years for cplay's home, and code, to resurface it was finally
+ forked. This exceptional software, originally written by Ulf
+ Betlehem, should not be forgotten.