|
|
@@ -6,18 +6,11 @@ Before building Rack or Rack plugins, you must install build dependencies provid |
|
|
|
Rack's own dependencies (GLEW, glfw, etc) do not need to be installed on your system, since specific versions are compiled locally during the build process. |
|
|
|
However, you need proper tools to build Rack and these dependencies. |
|
|
|
|
|
|
|
### Mac |
|
|
|
|
|
|
|
Install [Homebrew](https://brew.sh/), and install build dependencies. |
|
|
|
```bash |
|
|
|
brew install git wget cmake autoconf automake libtool jq python |
|
|
|
``` |
|
|
|
|
|
|
|
### Windows |
|
|
|
|
|
|
|
If you have an anti-virus program running, disable it or it may interfere with the build process. |
|
|
|
If you have an anti-virus program running, disable it or it may interfere with the build process or make builds very slow. |
|
|
|
|
|
|
|
Install the x86_64 version of [MSYS2](http://www.msys2.org/) and launch the MinGW 64-bit shell from the Start menu, *not the default MSYS shell*. |
|
|
|
Install [MSYS2](http://www.msys2.org/) and launch the MinGW 64-bit shell from the Start menu, *not the default MSYS shell*. |
|
|
|
Update the package manager itself: |
|
|
|
```bash |
|
|
|
pacman -Syu |
|
|
@@ -27,6 +20,13 @@ Then restart the shell and install packages. |
|
|
|
pacman -Su git wget make tar unzip zip mingw-w64-x86_64-gcc mingw-w64-x86_64-gdb mingw-w64-x86_64-cmake autoconf automake mingw-w64-x86_64-libtool mingw-w64-x86_64-jq python |
|
|
|
``` |
|
|
|
|
|
|
|
### Mac |
|
|
|
|
|
|
|
Install [Homebrew](https://brew.sh/), and install build dependencies. |
|
|
|
```bash |
|
|
|
brew install git wget cmake autoconf automake libtool jq python |
|
|
|
``` |
|
|
|
|
|
|
|
### Linux |
|
|
|
|
|
|
|
On Ubuntu 16.04+: |
|
|
@@ -43,7 +43,7 @@ pacman -S git wget gcc gdb make cmake tar unzip zip curl jq python |
|
|
|
|
|
|
|
*You do not need to build Rack to build plugins if you use the Rack SDK.* |
|
|
|
|
|
|
|
*If the build fails for you, please [report the issue](Issues.html) to help the portability of Rack.* |
|
|
|
*If the build fails for you, please [report the issue](Issues) to help the portability of Rack.* |
|
|
|
|
|
|
|
Clone this repository with `git clone https://github.com/VCVRack/Rack.git` and `cd Rack`. |
|
|
|
Make sure there are no spaces in your absolute path, since this breaks the Makefile-based build system. |
|
|
@@ -72,8 +72,8 @@ Run Rack. |
|
|
|
Complete the [Setting up your development environment](#setting-up-your-development-environment) section. |
|
|
|
|
|
|
|
Plugins can be built in two ways: |
|
|
|
- Download an [official Rack build](https://vcvrack.com/Rack) and [the latest Rack SDK](https://vcvrack.com/downloads/), and build plugins anywhere you like. (Easiest/fastest.) |
|
|
|
- [Build Rack from source](#building-rack) and build plugins in the `plugins/` folder. (Recommended for advanced developers.) |
|
|
|
- Download an [official Rack build](https://vcvrack.com/Rack.html) and [the latest Rack SDK](https://vcvrack.com/downloads/), and build plugins anywhere you like. (Easiest/fastest.) |
|
|
|
|
|
|
|
Download or clone the plugin source code, e.g. |
|
|
|
|
|
|
@@ -84,7 +84,7 @@ Clone the git repo's submodules. |
|
|
|
cd Fundamental |
|
|
|
git submodule update --init --recursive |
|
|
|
|
|
|
|
If using the Rack SDK, set the `RACK_DIR` environment variable by prefixing each of the following commands with `RACK_DIR=<Rack SDK dir>`. |
|
|
|
If using the Rack SDK, set the `RACK_DIR` environment variable by running `export RACK_DIR=<Rack SDK dir>`. |
|
|
|
|
|
|
|
Build plugin dependencies. (Most plugins don't require this step.) |
|
|
|
|
|
|
@@ -94,10 +94,10 @@ Build the plugin. |
|
|
|
|
|
|
|
make |
|
|
|
|
|
|
|
Create a plugin ZIP package. |
|
|
|
Create the distributable plugin package. |
|
|
|
|
|
|
|
make dist |
|
|
|
|
|
|
|
Or you may build, package, and install plugins to your [Rack user folder](FAQ.html#where-is-the-rack-user-folder) in one step. |
|
|
|
Or you may build, package, and install plugins to your [Rack user folder](FAQ#where-is-the-rack-user-folder) in one step. |
|
|
|
|
|
|
|
make install |