attempt to use new mikmod for djgpp build
[dosdemo] / libs / mikmod / dos / README
diff --git a/libs/mikmod/dos/README b/libs/mikmod/dos/README
new file mode 100644 (file)
index 0000000..b6d104a
--- /dev/null
@@ -0,0 +1,110 @@
+  Hello folks !\r
+\r
+\r
+This is libmikmod, version 3.3.10, a portable sound library for DOS.\r
+Comments & feedback are welcome.\r
+\r
+\r
+>> BUILDING LIBMIKMOD\r
+---------------------\r
+\r
+- If you're not building libmikmod for DOS, then you're lost in the sources.\r
+  Go up one directory, and read the main README file.\r
+\r
+This port has been designed to work only with DJGPP compiler. However, it\r
+should not be too complex to make it compile with any other compiler. If you\r
+manage to make libmikmod compile and work with another compiler, we'd like to\r
+hear from you. You'll likely have to write an appropiate makefile, or build\r
+things manually ...\r
+\r
+If you have all proper tools installed, just type\r
+\r
+       make -f Makefile.dj\r
+\r
+To make your library ready to use, copy the files 'libmikmod.a' and\r
+'include/mikmod.h' to your '%DJGPP%/lib' and '%DJGPP%/include' directories\r
+respectively.\r
+\r
+HTML documentation of the library, for programmers, is located in the doc\r
+directory.\r
+\r
+\r
+>> SUPPORTED SOUNDCARDS\r
+-----------------------\r
+\r
+Currently three brands of sound cards are supported under DOS:\r
+\r
+- Gravis Ultrasound and compatibles. Not tested with Interwave cards. If\r
+  somebody has one and can debug the code under Interwave, please drop us a note\r
+  (see email at bottom).\r
+\r
+- SoundBlaster and compatibles. There is only one driver that supports all\r
+  flavours of SoundBlasters:\r
+\r
+       + SB original (8-bit mono, 22KHz)\r
+       + SB 2.0 (DMA autoinit mode -> less clicks, 44KHz 8-bit mono).\r
+       + SB Pro (8-bit 22KHz stereo, 8-bit 44KHz mono)\r
+       + SB 16+ (8- and 16-bit stereo, up to 44Khz both)\r
+\r
+  Note that SB16 should cover AWE32/64 as well...\r
+\r
+- Windows Sound System and compatibles. Most today SoundBlaster clones\r
+  (including the CS4236B card used for testing) emulates (in hardware) WSS.\r
+  That's because Creative Labs copyrighted the SB16 interface and thus\r
+  clonemakers cannot do similar hardware without violating their rights, so\r
+  most of them only emulate SB Pro (see above).\r
+\r
+  WSS supports up to 44KHz 16-bit stereo. The following playback rates (in both\r
+  8- and 16-bit) are supported: 5510, 6620, 8000, 9600, 11025, 16000, 18900,\r
+  22050, 27420, 32000, 33075, 37800, 44100 and 48000 Hz.\r
+\r
+\r
+>> THANKS\r
+---------\r
+\r
+We would like to thank everyone who contributed to libmikmod. Their names\r
+are in the AUTHORS file for the significative contributions, but some other\r
+names can be found in the NEWS file. Thanks a lot ! Keeping libmikmod alive\r
+wouldn't be much fun without you.\r
+\r
+\r
+>> LICENSE\r
+----------\r
+\r
+The libmikmod sound library is covered by the GNU Library General Public\r
+License as published by the Free Software Fundation (you'll find it in the\r
+file COPYING.LIB) ; either version 2 of the licence, or (at your option)\r
+any later version.\r
+\r
+The GNU Lesser General Public License, version 2.1, in file COPYING.LESSER, can\r
+be considered as a later version of the LGPL, and is strongly recommended for\r
+people who will embed libmikmod in their application as a shared library.\r
+\r
+\r
+>> CONTACT AND DOWNLOAD INFO\r
+----------------------------\r
+\r
+libmikmod home page is located at SourceForge:\r
+\r
+    http://mikmod.sourceforge.net/\r
+    http://sourceforge.net/projects/mikmod/\r
+\r
+There's a mailing list (mikmod-public) for discussing the development\r
+of MikMod (new features, bugs, ideas...) Look for more information on\r
+the web site.\r
+\r
+Things related to the DOS port should also be forwarded to the DOS\r
+``portmaster'', Andrew Zabolotny, at: bit@eltech.ru\r
+\r
+\r
+>> LAST NOTES\r
+-------------\r
+\r
+We hope you'll enjoy using this version of libmikmod as well as we enjoyed\r
+debugging and improving it.\r
+\r
+-- Miodrag ("Miod") Vallat, 10/19/1999\r
+   miodrag@mikmod.darkorb.net\r
+\r
+   Andrew Zabolotny\r
+   bit@eltech.ru\r