aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorcbdev <cb@cbcdn.com>2019-11-13 22:23:10 +0100
committercbdev <cb@cbcdn.com>2019-11-13 22:23:10 +0100
commita7ca0def9e36912f582bd9f21dbc68808b3fd037 (patch)
tree366efd016e10b0d1c168a9b80bb11acdd240550c /README.md
parentccde53920cce56c2873c6cf35460fd74518dc79b (diff)
downloadmidimonster-a7ca0def9e36912f582bd9f21dbc68808b3fd037.tar.gz
midimonster-a7ca0def9e36912f582bd9f21dbc68808b3fd037.tar.bz2
midimonster-a7ca0def9e36912f582bd9f21dbc68808b3fd037.zip
Extend build instructions (Fixes #32)
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 18 insertions, 3 deletions
diff --git a/README.md b/README.md
index 9af09b3..dd728f0 100644
--- a/README.md
+++ b/README.md
@@ -176,6 +176,8 @@ for example
make jack.so
```
+#### Building for packaging or installation
+
For system-wide install or packaging builds, the following steps are recommended:
```
@@ -190,9 +192,22 @@ make install
Depending on your configuration of `DESTDIR`, the `make install` step may require root privileges to
install the binaries to the appropriate destinations.
-To build for Windows, you still need to compile on a Linux machine. Install the `mingw-w64` crosscompiler package
-and run `make windows` in the project directory. This will build `midimonster.exe` as well as a set of backends
-as DLL files.
+#### Building for Windows
+
+To build for Windows, you still need to compile on a Linux machine (virtual machines work well for this).
+
+In a fresh Debian installation, you will need to install the following packages (using `apt-get install` as root):
+ * `build-essential`
+ * `pkg-config`
+ * `git`
+ * `mingw-w64`
+
+Clone the repository and run `make windows` in the project directory.
+This will build `midimonster.exe` as well as a set of backends as DLL files, which you can then copy
+to the Windows machine.
+
+Note that some backends have limitations when building on Windows (refer to the backend documentation
+for detailed information).
## Development