===========================================================================
  irmp3 - Multimedia Audio Jukebox for Linux
  http://irmp3.sourceforge.net
  $Id: README,v 1.26 2003/05/07 16:05:40 boucman Exp $
===========================================================================

  Please send bug reports, comments and source code to the current
  maintainer Jeremy Rosen <jeremy.rosen@enst-bretagne.fr>


  GENERAL
-----------

irmp3 is a multimedia audio jukebox for Linux. Normally it runs in
background and does not provide any screen output. IRMP3 can be used
to play mp3 files and has support for several input and display devices,
like IR remote controls, LCD displays and keypads. A flexible,
modularized source allows easy implementation of new functions.


  COPYING
-----------
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program in a text-formatted file named COPYING; if 
not, write to the Free Software Foundation, Inc., 59 Temple Place - 
Suite 330, Boston, MA  02111-1307, USA.


  FEATURES
------------
 - Plays mp3 files and http streams (mpg123 required).
 - Plays audio CD's and manages CD media load/eject.
 - Powerful configuration for easy customization.
 - Playlist loadable from file or by recursively scanning dirs.
 - Provides file/directory browser for quick file selection.
 - Support for alarms, cron-triggered events.
 - Can produce audible beeps for users without a display.
 - Repeat single, repeat all and shuffle functions.
 - Mixer support for volume, balance, bass and treble settings.
 - Sleep timer with volume-fadeout.
 - Support control with IR remote controls (LIRC required).
 - Display status (song name, time, volume, etc) on LCDisplays (LCDproc
   required).
 - External keypad to control player (LCDproc required).
 - Flexible, modularized source allows easy implementation of new functions
   to developers.


  EXTERNAL SOFTWARE
---------------------

irmp3 does not handle everything itself but may use external programs
for it (e.g. for playing mp3 files). Depending on what you want to do,
you may require one or more of the following programs:

 - mpg123 (for playing mp3 files or streams)
	Version 0.59r or later is required (control_generic support
	is required).
   mpg123 homepage: http://www-ti.informatik.uni-tuebingen.de/~hippm/mpg123.html

 - LIRC (if you want to control your jukebox with an IR remote control)
	Version 0.5.1 or later required.
   LIRC homepage: http://fsinfo.cs.uni-sb.de/~columbus/lirc/

 - LCDproc (if you want LCD output or keypad input)
	Version 0.4-pre6 or later required.
	NOTE:  version 0.4-pre9 appears to SEGFAULT when used with IRMP3.
	version 0.4-pre8 does not have this problem.
   LCDproc homepage: http://lcdproc.omnipotent.net/

 - a utility to play soundfiles (.wav .au) on your system.


  MAILING LIST
----------------

There's a mailing list for the discussion of IRMP3 usage, development, 
problems.  This is also used to announce new versions. If you want to join,
simply visit:
	http://lists.sourceforge.net/lists/listinfo/irmp3-discussion


        
