aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorcbdev <cb@cbcdn.com>2019-08-31 17:23:22 +0200
committercbdev <cb@cbcdn.com>2019-08-31 17:23:22 +0200
commit191949152d803229275d7b98b184ff722a9549a2 (patch)
tree76cba7e231c4b468b87db5362b495353096fe7bf /README.md
parentba8cb9bfaf0c3699a728cef6918d7433a8690936 (diff)
downloadmidimonster-191949152d803229275d7b98b184ff722a9549a2.tar.gz
midimonster-191949152d803229275d7b98b184ff722a9549a2.tar.bz2
midimonster-191949152d803229275d7b98b184ff722a9549a2.zip
Update documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.md b/README.md
index 5c4233f..cf4d8d1 100644
--- a/README.md
+++ b/README.md
@@ -143,12 +143,19 @@ support for the protocols to translate.
* A C compiler
* GNUmake
+To build for Windows, the package `mingw-w64` provides a cross-compiler that can
+be used to build a subset of the backends as well as the core.
+
### Build
-Just running `make` in the source directory should do the trick.
+For Linux and OSX, just running `make` in the source directory should do the trick.
Some backends have been marked as optional as they require rather large additional software to be installed,
-for example the `ola` backend. To build these, run `make full` in the backends directory.
+for example the `ola` backend. To create a build including these, run `make full`.
+
+To build on windows, install the crosscompiler package listed above and run
+`make windows`. This will build `midimonster.exe` as well as a set of backends as DLL
+files.
## Development