Documentation is under preparation! We are seeking for people who support documentations and translations.
Install through homebrew
For easier installation, using Homebrew, a package manager tool for macOS and Linux is recommended.
If you have not installed homebrew, open terminal app and copy & paste next line and hit Enter key.
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
If you got homebrew, you can install mimium by typing
brew install mimium-org/mimium/mimium
That’s it! You can check if you have successfully installed or not by
mimium --version # will return mimium version:x.x.x
You can download built binary from GitHub Release Page.
mimium-vx.x.x-Darwin.zip is for macOS, mimium-vx.x.x-Linux.zip is for Linux and mimium-vx.x.x-Windows.zip is for Windows.
After finished downloading and extracting zip files, copy
bin folder into
/usr/local/bin, all files inside
/usr/local/lib. On GNU/Linux, note that the directory
/usr/local/lib is not in library path by default, so don’t forget to add this directory to
/etc/ld.so.conf.d/ and run
ldconfig as root.
Build from source manually
mimium compiler & runtime are written in C++ thus you need C++ compiler.
Xcode clang on macOS(you can install by just typing
xcode-select --install) and GCC >= 9 is recommended on Linux.
You also need several libraries and build tools below.
- git(version control system)
- cmake(cross-platform build tool)
on macOS, git and cmake are installed if you got xcode clang.
- llvm(compiler infrastructure library) >= v9.0.0
- flex(lexical analyzer)
- bison(parser generator) >= v3.3
- libsndfile(audio file loading library)
Also the codes depends on RtAudio(a cross-platform audio driver library) library but it will be downloaded & built automatically by cmake at a configure step.
You can of course install these dependencies via
Get a source code from GitHub repository
git clone https://github.com/mimium-org/mimium.git cd mimium # 'master' branch is a stable version. You can get the development version from 'dev' branch. git checkout master
mkdir build && cd build cmake ..
At this step, CMake will download and build RtAudio Library. You can pass generic options for CMake configuration option, for example,
-DCMAKE_INSTALL_PREFIX=/your/directoryspecifies installation path.
-DCMAKE_BUILD_TYPE=Debugspecifies build optimization level. You can choose from ‘Debug’, ‘Release’, ‘MinSizeRel’ , ‘RelWithDebinfo’
-DCMAKE_CXX_COMPILER=/path/to/compilerspecifies C++ compiler.
-DBUILD_SHARED_LIBS=ONBuild libraries as dynamic-link library.（Not well tested on Linux and Windows）。
-DBUILD_TEST=ONInclude tests to build targets.
-DENABLE_COVERAGE=ONEnable compiler option to calculate code-cvoerage using GCov.
cmake --build build -j
-j option controls maximum number of parallel CPU threads usage(e.g.
-j8 means up to 8 threads).
-j with no number means possible maximum number on your platform.
cmake --build build target=install
#(on build folder) cmake --build build --target uninstall
This uninstall target uses information on
build/install_manifest.txt generated by CMake at installation steps. If you fail to remove files, check this file and try build , installation and uninstall steps sequentialy again.
Syntax Highlight for Visual Studio Code
Currently, we have a syntax highlight for Visual Studio Code, a cross platform text editor/development environment.
You can get by searching
mimium-language on an extension panel on VS Code or you can get from the link below.
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.