  Hello folks !


This is MikMod, version 3.1.6, a module player for OS/2.
As usual with each new version, there's a lot of bugfixes and improvements.
Check out the file 'NEWS' for more information.


>> BUILDING MIKMOD
------------------

This MikMod version can build with either libmikmod 3.1.7 (shared library
version 2), or an older version, but all the configuration functions are not
available for older versions.

- If you're not building libmikmod for OS/2, then you're lost in the sources.
  Go up one directory, and read the main README file.

So you're on a good old OS/2 system, aren't you ? With a customized Object
Desktop or some equivalent tool collection ?

I hope you've installed REXX support during the system installation. If you
didn't, you lose. Run 'selective install' from the system setup folder, install
REXX support, check it works, and come back here.

The first thing you need is to get and compile the libmikmod sound library,
which is not bundled with MikMod anymore !
If you don't know where to get libmikmod, look at the "contact and download
info" section later in this document.

Oh, I almost forgot : you need long filenames to compile MikMod, so you'll
have to compile it on an HPFS drive, or an ext2fs drive, or a network drive
where you can use decent-size filenames.

Currently, MikMod can be build under OS/2 only with the emx compiler
or the Watcom compiler.

In this directory, run 

  configure

The configure script will ask you which compiler to use.

After the configuration has finished and the Makefiles are created, just
run

  make

and you'll get your MikMod binary in the src directory. Just copy the
file ``..\src\mikmod.exe'' somewhere in your PATH, and enjoy !

If the build fails, I'd like to hear from you to correct the problem.


>> USING MIKMOD
---------------

Run MikMod with the ``--help'' parameter to get the available options.
Program documentation is available as an Unix man page (..\src\mikmod.1) which
you can read if you've got a port of the 'man' tool.

Also, after you've run MikMod for the first time, you might want to
customize your mikmod.cfg file, either from the configuration panel or by
editing the file yourself, so you won't need to supply the same options to
MikMod all the time. This file will be created in the directory pointed to by
the HOME environment variable. If you don't have the HOME environment variable,
the file will be created in C:\, which is probably not what you want and should
encourage you to have the HOME environment variable set.

Once you're in the player, if you haven't choosed terse mode (a la
MikMod 2), pressing the H key will give you an help screen with the list
of the keys you can use. I hope it's understandable.

Note that if you're using the DART driver, there will be a small delay before
commands are processed.

If you used the playlist features of the previous MikMod versions, your
old playlist won't work anymore since the playlist format has changed.
Now the playlist files must have an .mpl extension. To convert your old
playlists into the new format, get an OS/2 port of the Unix 'awk' command
(several exist, including an official IBM version found on DevCon...) and use
the 'convert_playlist' awk script :

  ./convert_playlist < my_old_playlist > my_new_playlist.mpl

I know I'm getting lazy and could have written a REXX script for this, but
it's kinda like reinventing the wheel and I prefer work on the real code.
Hope you won't mind (-: Besides, I only know of a few MikMod/2 users, so if you
want to see more OS/2 interest from my side, let me know you're running
MikMod/2 !


>> THANKS
---------

I would like to thank everyone who contributed to libmikmod. Their names
are in the AUTHORS file for the significative contributions, but some other
names can be found in the NEWS file. Thanks a lot ! Keeping MikMod alive
wouldn't be much fun without you.


>> LICENSE
----------

The MikMod module player is covered by the GNU General Public License as
published by the Free Software Fundation (you'll find it in the file COPYING) ;
either version 2 of the licence, or (at your option) any later version.


>> CONTACT AND DOWNLOAD INFO
----------------------------

* email :
  Please send all your MikMod related e-mail to me, at :
  miodrag@mikmod.darkorb.net

* chat :
  People wanting to have a ``live talk'' with me can reach me on IRC (IRCnet
  and sometimes Undernet) under the nick 'effetaipa'.

* web :
  MikMod and libmikmod home page is located at :
    http://mikmod.darkorb.net
  The European mirror is at:
    http://www.multimania.com/miodrag/mikmod

* ftp :
  Latest releases of libmikmod can be found:
  - on the official ftp site
    ftp://mikmod.darkorb.net
  - on metalab (formerly known as sunsite) and its mirrors
    ftp://metalab.unc.edu/pub/Linux/apps/sound/libs for libmikmod, and
    ftp://metalab.unc.edu/pub/Linux/apps/sound/players for MikMod
  - on hobbes, in source and OS/2 binary forms
    ftp://hobbes.nmsu.edu/pub/os2/mmedia


>> LAST NOTES
-------------

I hope you'll enjoy using this version of MikMod as well as I enjoyed
debugging and improving it.

-- Miodrag ("Miod") Vallat, 07/05/1999
   miodrag@mikmod.darkorb.net
