1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Wed Sep 27 09:22:32 2017 +0200
     1.3 @@ -0,0 +1,59 @@
     1.4 +Description:
     1.5 +
     1.6 +        cplay is a curses front-end for various audio players. It aims
     1.7 +        to provide a power-user-friendly interface with simple filelist
     1.8 +        and playlist control. cplay is written in Python and can use
     1.9 +        either pyncurses or the standard curses module.
    1.10 +
    1.11 +Requirements:
    1.12 +
    1.13 +        - cplay                   http://www.tf.hut.fi/~flu/cplay/
    1.14 +        - python                  http://www.python.org/
    1.15 +        - python-oss  (optional)  http://net.indra.com/~tim/ossmodule/
    1.16 +        - mpg321      (optional)  http://sourceforge.net/projects/mpg321/
    1.17 +        - ogg123      (optional)  http://www.vorbis.com/
    1.18 +        - mpg123      (optional)  http://www.mpg123.org/
    1.19 +        - splay       (optional)  http://splay.sourceforge.net/
    1.20 +        - madplay     (optional)  http://www.mars.org/home/rob/proj/mpeg/
    1.21 +        - mikmod      (optional)  http://www.mikmod.org/
    1.22 +        - fintl       (optional)  http://www.python.org/sigs/i18n-sig/
    1.23 +        - pyncurses   (optional)  http://pyncurses.sourceforge.net/
    1.24 +        - ID3-py      (optional)  http://id3-py.sourceforge.net/
    1.25 +        - pyvorbis    (optional)  http://www.duke.edu/~ahc4/pyogg/
    1.26 +        - xmp         (optional)  http://xmp.sf.net/
    1.27 +        - sox         (optional)  http://sox.sf.net/
    1.28 +        - speex       (optional)  http://www.speex.org/
    1.29 +
    1.30 +Installation:
    1.31 +
    1.32 +        make install
    1.33 +
    1.34 +Usage:
    1.35 +
    1.36 +        cplay [-nrRv] [ file | dir | playlist ] ...
    1.37 +
    1.38 +        When in doubt, press 'h' for a friendly help page.
    1.39 +
    1.40 +Configuration:
    1.41 +
    1.42 +        If you would like to change options passed to the actual players
    1.43 +        just edit the PLAYERS list in the cplay script or put the PLAYERS
    1.44 +        definition in either ~/.cplayrc or /etc/cplayrc. If one of these
    1.45 +        files is available, it is executed by cplay before initialization.
    1.46 +
    1.47 +        Note, currently there is no version control for the rc-file!
    1.48 +
    1.49 +Miscellaneous:
    1.50 +
    1.51 +        In order for either mp3info (ID3) or ogginfo to work,
    1.52 +        both corresponding python modules have to be installed.
    1.53 +        This will probably change someday.
    1.54 +
    1.55 +        A playlist can contain URLs, but the playlist itself will
    1.56 +        have to be local. For mpeg streaming, splay is recommended.
    1.57 +
    1.58 +        It is also possible to pipe a playlist to cplay, as stdin
    1.59 +        will be reopened on startup unless it is attached to a tty.
    1.60 +
    1.61 +        Remote control via /var/tmp/cplay_control; see lircrc.
    1.62 +