First iteration of build instructions

This commit is contained in:
Robert Bendun 2022-10-20 14:37:50 +02:00
parent 2ac95e3b14
commit 346c66a8f4
2 changed files with 28 additions and 0 deletions

View File

@ -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 * `: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 * `:quit` REPL command that mirrors `:exit` command
* Virtual MIDI output port creation as default action (--output connects to existing one) * Virtual MIDI output port creation as default action (--output connects to existing one)
* Added build instructions
### Changed ### Changed

27
build_instructions.md Normal file
View File

@ -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.