From 71d37952e46d1cab76f187ac87cb0445106d9f39 Mon Sep 17 00:00:00 2001 From: Yvan Volochine Date: Sat, 16 Jul 2016 14:21:47 +0200 Subject: [PATCH 1/2] readme: remove trailing whitespaces Signed-off-by: Yvan Volochine --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c30756438e..cd78f5ea6d 100644 --- a/README.md +++ b/README.md @@ -19,13 +19,13 @@ To compile from source (see below), either download a tarball or clone the repos ## 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 @@ -57,10 +57,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 @@ -113,10 +113,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. From e6125e99b3b57fcbd81f5cb1687cd64e2f4f8d97 Mon Sep 17 00:00:00 2001 From: Yvan Volochine Date: Sat, 16 Jul 2016 14:23:14 +0200 Subject: [PATCH 2/2] readme: add infos about cloning with submodules Signed-off-by: Yvan Volochine --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cd78f5ea6d..f94ccd3e83 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,11 @@ 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