From 27df62d9e89fcf2dca72c316e18f4168d7fdb003 Mon Sep 17 00:00:00 2001 From: Vitaly Novichkov Date: Tue, 24 Apr 2018 23:23:54 +0300 Subject: [PATCH] ReadME: Update manual for CMake options --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ab605d5..ee80bb8 100644 --- a/README.md +++ b/README.md @@ -42,11 +42,17 @@ sudo make install ``` ## Available CMake options -* **CMAKE_PREFIX_PATH** - destinition folder where libADLMIDI will be installed. On Linux it is /usr/local/ by default. +* **CMAKE_PREFIX_PATH** - destinition folder where libOPNMIDI will be installed. On Linux it is /usr/local/ by default. * **CMAKE_BUILD_TYPE** - Build types: **Debug** or **Release** * **WITH_MIDIPLAY** - (ON/OFF, default OFF) Build demo MIDI player (Requires SDL2 and also pthread on Windows with MinGW) -* **WITH_EMBEDDED_BANKS** - (ON/OFF, default ON) Enable or disable embedded banks (Original ADLMIDI and older versions of libADLMIDI are had embedded-only banks with no ability to load custom banks in runtime). -* **USE_GENS_EMULATOR** - (ON/OFF, default ON) Use GENS 2.10 emulator instead of Nuked OPN2. This emulator has less accuracy and seems outdated (will be replaced with MAME), but it is well optimized for a work on slow devices such as older computers, embedded or mobile devices. +* **WITH_VLC_PLUGIN** - (ON/OFF, default OFF) Compile VLC plugin. For now, works on Linux and VLC version 2.2.2. Support for newer VLC versions and other platforms comming soon! +* **WITH_MIDI_SEQUENCER** - (ON/OFF, default ON) Enable built-in MIDI sequencer to play loaded MIDI files. When you will disable MIDI sequencer, Real-Time functions only will work. Use this option when you are making MIDI plugin or real-time MIDI driver. +* **USE_MAME_EMULATOR** - (ON/OFF, default ON) Enable support for MAME YM2612 emulator. Well-accurate and fast on slow devices. +* **USE_NUKED_EMULATOR** - (ON/OFF, default ON) Enable support for Nuked OPN2 emulator. Very accurate, however, requires a very powerful CPU. *Is not recommended for mobile devices!*. +* **USE_GENS_EMULATOR** - (ON/OFF, default ON) Enable support for GENS 2.10 emulator. Very outdated and inaccurate, but fastest. +* **WITH_MUS_SUPPORT** - (ON/OFF, default ON) Enable support for DMX MUS format in built-in MIDI sequencer. +* **WITH_XMI_SUPPORT** - (ON/OFF, default ON) Enable support for AIL XMI format in built-in MIDI sequencer. +* **WITH_UNIT_TESTS** - (ON/OFF, default OFF) Also compile unit-tests of internal features. * **libOPNMIDI_STATIC** - (ON/OFF, default ON) Build static library * **libOPNMIDI_SHARED** - (ON/OFF, default OFF) Build shared library