Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
now has more installation details
  • Loading branch information
jrsurge committed Jun 2, 2017
1 parent bd07bed commit 3fcaf96
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,33 @@ SuperDiffuse(8,8,8);
```

# Installation
In SuperCollider, run:

__SuperDiffuse uses SuperCollider, so you must have it installed first:__
https://supercollider.github.io

## Automatic:
SuperDiffuse is written as a Quark, so __if you have Git installed__ (Windows users will need to manually install Git), run the following in SuperCollider:

```supercollider
Quarks.install("https:/github.com/jrsurge/SuperDiffuse")
```

Then restart SuperCollider (or just recompile the class library with `Ctrl/Cmd + Shift + L`).

## Manual:
* Download a release from Github:
https://github.com/jrsurge/SuperDiffuse/releases

* Unzip into a folder called `SuperDiffuse` (doesn't matter where, we'll move it soon)

* In SuperCollider, go to: __File > Open user support directory__

* If it doesn't already exist, make a folder called `Extensions`

* Move the `SuperDiffuse` folder into the `Extensions` folder

Then restart SuperCollider (or just recompile the class library with `Ctrl/Cmd + Shift + L`)

# Running

## Pre-flight checks
Expand Down

0 comments on commit 3fcaf96

Please sign in to comment.