
This file describes how to install IRMP3. You need some additional
software. Please refer to the README on how to get this software
and refer to the program's documentation on how to install it.


OPTIONAL SOFTWARE
-----------------

* mpg123
	To play mp3 files with IRMP3, you need to have the mpeg
	player mpg123. You need at least version 0.59r. Type
	"mpg123" at your shell to check if you have mpg123
	0.59r or later. The configuration script will check your version of
	mpg123 for you. If you have mpg321 installed instead of mpg123,
	irmp3d will work with it

* LIRC
	If you want to control IRMP3 with an IR remote control,
	you need an IR receiver hardware and the LIRC software
	installed. See the LIRC homepage for more information
	about hardware and software setup.

* LCDproc
	IRMP3 can use LCDproc for output on an LCDisplay or for
	input from an attached keypad. See the LCDproc documentation
	for supported hardware and how to install it.

	NOTE:  LCDproc version 0.4-pre9 appears to SEGFAULT when 
	used with IRMP3.  version 0.4-pre8 does not have this problem.

* (a program to play soundfiles)
	IRMP3 will optionally produce beeps when commands are
	executed.  You will need soundfiles (samples provided)
	and a program to play them (like sox or play).

* Timidity
	if you want to play midi files, you can use timidity to do so.
	The install script will chack your timidity version for you

* Mplayer
	Mplayer is a video player which can also be used as an audio
	player. Properly installed and configured, it is able to play about
	anything. Irmp3d can use mplayer to play anything mplayer is able
	to play, but as sound only.

* libmagic
	This library is the backend of the "file" filetype recognition
	utility. If it's available irmp3d will use it to recognise the
	files it tries to play. If it isn't available, irmp3d will attempt
	to do smart guesses on the file extension

INSTALLING IRMP3
----------------

1) You should already have unpacked the irmp3-x.x.x.tar.gz file into
   a directory of your choice.

2) run the ./configure script in the root of the irmp3 directory. This
   should find and check the version of any of the programs and libraries
   mentionned above. 

3) Compile IRMP3 by doing 'make all'. If you  have problem with a
   particular module, you can disable it by running ./configure with the
   --disable-mod-<foo> option

4) Install IRMP3 by doing 'make install' as root.

5) create a new configuration file by running irmp3conf (as root). You
   should also run this utility each time you upgrade your irmp3.

6) adapt the configuration file to suit your own taste. By default it will
   be in /usr/local/etc/irmp3d.conf In particular, you should set
   irmp3_init_command to "playlist loaddir /absolute/path/to/music/*"

7) Have fun :-)

