  Hello folks !


This is libmikmod, version 3.1.7, a portable sound library for OS/2.
This version is mainly a bugfixed 3.1.6 version... with some new features,
though.
Check out the file 'NEWS' for more information.


>> BUILDING LIBMIKMOD
---------------------

- 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.

Currently, libmikmod can be build under OS/2 only with the emx compiler
or the Watcom compiler. Borland C lacks a 64-bit integer type and can't be
used.  You'll need the MMPM/2 toolkit (included in all the Warp toolkits) to
compile the MMPM/2 driver. The Warp 4 toolkit is required if you want to build
the DART driver, too.

Oh, I almost forgot : you need long filenames to compile libmikmod, 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.

In this directory, run

  configure

You will then be asked some questions.
First, you'll have to choose your compiler. 

If you choose emx, you can either build a static library, or a DLL with an
import library.

Then, you will be asked if you want to build a debug version ; this
option is mainly intended for the libmikmod developers, so you should
answer "N" here.

The next step is the driver selection. You'll be asked if you want the
MMPM/2 and DART drivers. Since DART is not available on OS/2 older than
Warp 4, the MMPM/2 driver is recommended for pre-Warp 4 systems.
Otherwise, the DART driver is preferable, but you can include both to
be sure your libmikmod library will work on every 32 bit version of OS/2.

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

  make

and you'll get your libmikmod library in the libmikmod directory.
If the build fails, I'd like to hear from you to correct the problem.

To make you library ready to use, copy the file '..\include\mikmod.h' to your
compiler include directory, and '..\libmikmod\mikmod.lib` to your compiler
library directory. If you built a DLL, put the DLL (..\libmikmod\mikmod.dll)
in a directory which appears in your LIBPATH.

HTML documentation of the library, for programmers, is located in the doc
directory.


>> 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 libmikmod alive
wouldn't be much fun without you.


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

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

The GNU Lesser General Public License, version 2.1, in file COPYING.LESSER, can
be considered as a later version of the LGPL, and is strongly recommended for
people who will embed libmikmod in their application as a shared library.


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

* email :
  Please send all your libmikmod 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 :
  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
  - 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 libmikmod as well as I enjoyed
debugging and improving it.

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