Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Improve the linux build documentation
  • Loading branch information
baconpaul authored Feb 4, 2019
1 parent 31db1b1 commit 186cd3e
Showing 1 changed file with 19 additions and 10 deletions.
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,17 +205,17 @@ is an available option.

Download `premake5` from https://premake.github.io/download.html#v5

Untar the package, and move it to `~/bin/` so the install script can find it.
Untar the package, and move it to `~/bin/` or elsewhere in your path
so the install script can find it.

For VST2, you will need the `VST2 SDK` - unzip it to a folder of your choice

and set an environment variable like this:
and set `VST2SDK_DIR` to point to it.

```
export VST2SDK_DIR="/your/path/to/VST2SDK
export VST2SDK_DIR="/your/path/to/VST2SDK"
```

Do remember to install the dependencies
You will need to install a set of dependencies.

- build-essential
- libcairo-dev
Expand All @@ -225,21 +225,30 @@ Do remember to install the dependencies
- libxcb-keysyms1-dev
- libxcb-util-dev

Run `apt-get install libgtkmm-3.0-dev`
Then `git clone` surge and update the submodules:

```
git clone https://github.com/surge-synthesizer/surge.git
cd surge
git submodule update --init --recursive
```

Run `premake gmake2`
You can now build with the command

```
./build-linux.sh build
```

Run `./build-linux.sh clean`
which will run premake and build the asset.

Run `./build-linux.sh build`
To use the VST, you need to install it locally along with supporting files. You can do this manually
if you desire, but the build script will also do it.

```
./build-linux.sh install-local
```

Some further discussion is at https://github.com/surge-synthesizer/surge/issues/19
For other options, you can do `./build-linux.sh --help`.

## References

Expand Down

0 comments on commit 186cd3e

Please sign in to comment.