Skip to content

Commit

Permalink
Merge pull request supercollider#105 from gusano/topic/readme-update
Browse files Browse the repository at this point in the history
Readme update
  • Loading branch information
telephon authored Jul 16, 2016
2 parents 604cea3 + e6125e9 commit afe31b2
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,22 @@ For community discussion and support see the [SuperCollider mailing lists](http:

Compiled releases are available from the [github release page](https://github.com/supercollider/sc3-plugins/releases). For older versions (2013). see the [sourceforge project page](http://sourceforge.net/projects/sc3-plugins/files/).

To compile from source (see below), either download a tarball or clone the repository from the [sc-plugins github page](https://github.com/supercollider/sc3-plugins).
To compile from source (see below), either download a tarball or clone this repository:

```shell
$ git clone --recursive https://github.com/supercollider/sc3-plugins.git
```

## Binary install

Copy the contents of the tarball/`dmg` to your SuperCollider extensions folder.
You can find out which one that is by evaluating
You can find out which one that is by evaluating

```
Platform.userExtensionDir
```

from within SuperCollider. Alternatively, you may install the extensions system-wide by copying to
from within SuperCollider. Alternatively, you may install the extensions system-wide by copying to

```
Platform.systemExtensionDir
Expand Down Expand Up @@ -57,10 +61,10 @@ WARNING: on OSX, if you want to install into `CMAKE_INSTALL_PREFIX`, you have to

### Cmake Options

+ Set install target
+ Set install target
* (default on linux `/usr/local`)
* `sc3-plugins/build/$ cmake -DCMAKE_INSTALL_PREFIX=/usr/local ..`
+ Install in cmake build folder instead of `CMAKE_INSTALL_PREFIX`
+ Install in cmake build folder instead of `CMAKE_INSTALL_PREFIX`
* (OSX ONLY, default=ON)
* `sc3-plugins/build/$ cmake -DIN_PLACE_BUILD=ON`
+ Build the plugins as quarks
Expand Down Expand Up @@ -113,10 +117,10 @@ sc3-plugins/build/$ cmake -DSC_PATH=/PATH/TO/SC -DOSX_PACKAGE=1 ..
sc3-plugins/build/$ make && make install
```

The DiskImage will be generated in `./sc3-plugins/build/build_osx` containing
The DiskImage will be generated in `./sc3-plugins/build/build_osx` containing

+ a `License.txt`,
+ this `README.txt`, and
+ a `License.txt`,
+ this `README.txt`, and
+ the `SC3plugins` folder.
+ Note: the quarks ```DIRECTORY```-folder is also included by default.

Expand Down

0 comments on commit afe31b2

Please sign in to comment.