From ec0933e8ff70fef69e90bc1c51bd65a468ac8c9c Mon Sep 17 00:00:00 2001 From: Andrew Belt Date: Mon, 3 Sep 2018 18:06:03 -0400 Subject: [PATCH] Move building instructions to manual --- README.md | 79 +------------------------------------------------------ 1 file changed, 1 insertion(+), 78 deletions(-) diff --git a/README.md b/README.md index 5bb3489f..78c5d01f 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,7 @@ *Rack* is the engine for the VCV open-source virtual modular synthesizer. -![Rack screenshot](https://vcvrack.com/images/screenshot.png) - -This README includes instructions for building Rack from source. For information about the software, go to https://vcvrack.com/. +For information about the software, go to the [VCV website](https://vcvrack.com/) or the [VCV Rack manual](https://vcvrack.com/manual/). ## The [Issue Tracker](https://github.com/VCVRack/Rack/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) is the official developer's forum @@ -15,81 +13,6 @@ Please vote on feature requests by using the Thumbs Up/Down reaction on the firs I rarely accept code contributions to Rack itself, so please notify me in advance if you wish to send a pull request. -## Setting up your development environment - -Before building Rack, you must install build dependencies provided by your system's package manager. -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 [Xcode](https://developer.apple.com/xcode/). -Using [Homebrew](https://brew.sh/), install the build dependencies. -``` -brew install git wget cmake autoconf automake libtool -``` - -### Windows - -Install [MSYS2](http://www.msys2.org/) and launch the MinGW 64-bit shell (not the default MSYS shell). -``` -pacman -S git wget make tar unzip zip mingw-w64-x86_64-gcc mingw-w64-x86_64-cmake autoconf automake mingw-w64-x86_64-libtool -``` - -### Linux - -On Ubuntu 16.04: -``` -sudo apt install git curl cmake libx11-dev libglu1-mesa-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev zlib1g-dev libasound2-dev libgtk2.0-dev libjack-jackd2-dev -``` - -On Arch Linux: -``` -pacman -S git wget gcc make cmake tar unzip zip curl -``` - -## Building - -*If the build fails for you, please report the issue with a detailed error message 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, as this breaks many build systems. - -Clone submodules. - - git submodule update --init --recursive - -Build dependencies locally. -You may add `-j$(nproc)` to your make commands to parallelize builds across all CPU cores. - - make dep - -Build Rack. - - make - -Run Rack. - - make run - -## Building plugins - -Be sure to check out and build the version of Rack you wish to build your plugins against. - -You must clone the plugin in Rack's `plugins/` directory, e.g. - - cd plugins - git clone https://github.com/VCVRack/Fundamental.git - -Clone submodules. - - cd Fundamental - git submodule update --init --recursive - -Build plugin. - - make dep - make ## Licenses