Documents update and new readme file was added

WohlSoft · Jul 19, 2019 · d0d548b · d0d548b
1 parent 6723b47
commit d0d548b
Show file tree

Hide file tree

Showing 5 changed files with 179 additions and 81 deletions.
diff --git a/CHANGES.X.txt b/CHANGES.X.txt
@@ -1,3 +1,19 @@
+2.5.0:
+Vitaly Novichkov - 2019-02-24
+ * Added more OPL/OPN emulators enum fields for libADLMIDI and libOPNMIDI
+Vitaly Novichkov - 2019-03-10
+ * Added support for libXMP tracker module music player library
+Vitaly Novichkov - 2019-05-10
+ * Use DosBox emulator by default in ADLMIDI
+Vitaly Novichkov - 2019-05-28
+ * Fixed MP3 file detection by raw data to don't rely on filename extensions
+ Vitaly Novichkov - 2019-07-11
+ * Added new path arguments to load custom external banks for libADLMIDI and libOPNMIDI
+Vitaly Novichkov - 2019-07-11
+ * Added API to change ADLMIDI and OPNMIDI's chips count to control performance and polyphony
+Vitaly Novichkov - 2019-07-16
+ * Added music tempo change API (initially works with MIDI, GME, and XMP)
+
 2.4.0:
 Vitaly Novichkov - 2019
  * DosBox OPL3 emulator will be used by default on libADLMIDI for performance

diff --git a/README.md b/README.md
@@ -0,0 +1,23 @@
+# SDL Mixer X
+
+An audio mixer library, a fork of [SDL_mixer](http://www.libsdl.org/projects/SDL_mixer/) library
+
+# Description
+SDL_Mixer is a sample multi-channel audio mixer library.
+It supports any number of simultaneously playing channels of 16 bit stereo audio,
+plus a single channel of music, mixed by the popular FLAC, OPUS, XMP, ModPlug,
+MikMod MOD, Timidity MIDI, FluidSynth, Ogg Vorbis, FLAC, libMAD, and MPG123 MP3 libraries.
+
+SDL Mixer X - is an extended fork made by Vitaly Novichkov "Wohlstand" in
+13 January 2015. SDL_mixer is a quick and stable high-quality audio library,
+however, it has own bunch of deffects such as broken resampling, incorrect
+playback of WAV files, inability to choose MIDI backend in runtime,
+inability to customize Timidty patches path, No support for cross-fade
+and parallel streams playing (has only one musical stream. Using of very
+long Chunks is ineffectively), etc. The goal of this fork is resolving those
+issues, providing more extended functionality than was originally,
+and providing support for more supported audio formats.
+
+* [More detailed information](docs/index.md)
+* [Read original ReadMe](README.txt)
+
diff --git a/docs/SDL_mixer_ext.html b/docs/SDL_mixer_ext.html