diff --git a/CHANGELOG.md b/CHANGELOG.md index 0d31c7d..fe4953f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 * `:load` REPL command to load Musique files inside Musique session. Allows for delayed file execution after a connection * `:quit` REPL command that mirrors `:exit` command * Virtual MIDI output port creation as default action (--output connects to existing one) +* Added build instructions ### Changed diff --git a/build_instructions.md b/build_instructions.md new file mode 100644 index 0000000..a2e7fe1 --- /dev/null +++ b/build_instructions.md @@ -0,0 +1,27 @@ +# Musique build instructions + +## Linux + +Consult README.md. + +## MacOS + +Required system dependency is fairly new C++ compiler. The simplest way is to type `clang` in terminal, which should launch installation of C++ compiler. Next provided compiler version: +``` +$ clang++ --version +``` + +Minimal supported version is __14__. On older editions of MacOS one can aquire new editions by [Homebrew](https://brew.sh/). After homebrew installation install clang via `brew install llvm`. + +Next you should be able to build project by running `make` command inside main directory (in released zip file in `source_code` directory). + +## Windows + +Windows support is provided via cross compilation. Mingw GCC C++ compiler is required to produce Windows binaries. + +``` +$ make os=windows +``` + +will create `bin/musique.exe` that can be used on x86_64 Windows operating systems. +