Skip to content

Latest commit

 

History

History
134 lines (84 loc) · 3.12 KB

INSTALL.md

File metadata and controls

134 lines (84 loc) · 3.12 KB
Raw

Drumstick MIDI Monitor (a.k.a. kmidimon)

Requirements

You need the following software:

  • CMake 3.16 or later
  • Qt libraries 6.2 or later (or Qt5 >= 5.12)
  • ALSA library
  • Drumstick 2.9 or later

You will need CMake 3.16 or newer. If your Linux distribution doesn't provide CMake, or if it provides an older version, you can get it here:

https://cmake.org/download/

There are ready to use binary packages available for Linux from that page. If you must build it from source, please read the instructions supplied here:

https://cmake.org/install/

Qt and ALSA are probably available from your Linux distribution repositories. If not, you may find them here:

https://download.qt.io/official_releases/online_installers/

https://www.alsa-project.org/wiki/Main_Page

This program needs the Drumstick libraries. You should install the development package before trying to compile kmidimon. Drumstick is available here:

https://drumstick.sourceforge.io

Building

Unpack the tarball or check out SVN. Assuming that you have the source in ~/src/kmidimon, you need to change to that directory:

    cd ~/src/kmidimon
    mkdir build

Now run CMake to generate the build files.

    cmake -S . -B build

Finally build and (sudo) make install, and you're done.

    cmake --build build
    sudo cmake --install build

To uninstall, use:

    sudo cmake --build build --target uninstall

Advanced Build Options

By default, make will output brief details of each build step. If you prefer to see full command lines, use:

    cmake --build build --verbose

Another option, useful for packagers, is setting DESTDIR at install time. The DESTDIR directory will be prepended to the prefix when copying the files:

    cmake --install build --prefix ~/rpmroot

Some variables you may want to set:

  • CMAKE_INSTALL_PREFIX

    cmake -DCMAKE_INSTALL_PREFIX=/opt is the equivalent to ./configure --prefix=/opt for programs that use autotools

  • CMAKE_PREFIX_PATH (location of alternative Qt5 or other libs):

    cmake -DCMAKE_PREFIX_PATH=~/Qt/5.15.12/gcc_64

  • EMBED_TRANSLATIONS (instead of installing translations):

    cmake -DEMBED_TRANSLATIONS=Yes

  • BUILD_DOCS (default ON, to compile or use the pre-built documentation)

    cmake -DBUILD_DOCS=OFF

  • USE_QT5

    cmake -DUSE_QT5=ON (to choose explicitly Qt5 instead of Qt6)

  • Drumstick_DIR (location of the custom Drumstick build):

    cmake -DDrumstick_DIR=~/src/drumstick/build

If you would prefer to avoid all this typing, you can use ccmake to view and change these options using a friendly curses-based interface:

    ccmake -S ~/src/kmidimon -B ~/src/kmidimon-build

or a GUI equivalent:

    cmake-gui -S ~/src/kmidimon -B ~/src/kmidimon-build

Dealing with Configuration Problems

First, look for an answer in CMake FAQ:

https://gitlab.kitware.com/cmake/community/-/wikis/FAQ

You may want to read the documentation at:

https://cmake.org/cmake/help/v3.14/

If you can't solve your problem, open a request for support at the project site:

https://sourceforge.net/p/kmidimon/support-requests/