Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Readme updated to reflect changes.
  • Loading branch information
joslloand committed Jun 16, 2017
1 parent 94a2c2f commit 9a7ac21
Showing 1 changed file with 55 additions and 30 deletions.
85 changes: 55 additions & 30 deletions source/ATK/sc/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
ATK for SuperCollider3 : Read Me
ATK UGens for SuperCollider3 : Read Me
========================

This is the SuperCollider3 version of the Ambisonic Toolkit (ATK).
It can be used with [SuperCollider3](http://supercollider.github.io/) on OSX,
Linux and Windows, and is distributed via the
[sc3-plugins](https://github.com/supercollider/sc3-plugins) project.
This is the unit generator plugin (UGen) component of the SuperCollider3 version
of the Ambisonic Toolkit (ATK), which is distributed via the
[sc3-plugins](https://github.com/supercollider/sc3-plugins) project. It can be
used with [SuperCollider3](http://supercollider.github.io/) on OSX, Linux and
Windows.

The Ambisonic Toolkit (ATK) is intended to bring together a number of
tools and methods for working with Ambisonic surround sound. The intention
Expand All @@ -23,8 +24,8 @@ technique.

We hope you enjoy the ATK!

For more information please visit the [Ambisonic Toolkit
website](http:www.ambisonictoolkit.net/) or send us an
For more information please visit the
[Ambisonic Toolkit website](http:www.ambisonictoolkit.net) or send us an
[e-mail](mailto:info[at]ambisonictoolkit.net). See also
[Introducing the Ambisonic Toolkit](http://doc.sccode.org/Guides/Intro-to-the-ATK.html)
for an overview on working with the ATK for SuperCollider3.
Expand All @@ -50,22 +51,41 @@ or later. Download the latest version

 

atk-sc3 Quark
-----------

The ATK for [SuperCollider3](http://supercollider.github.io)'s classes,
extension methods and documentation are distributed via the
[atk-sc3 Quark](https://github.com/ambisonictoolkit/atk-sc3). Start by reviewing
the Quark installation instructions
[found here](https://github.com/supercollider-quarks/quarks#installing). See
also [Using Quarks](http://doc.sccode.org/Guides/UsingQuarks.html).

With [git](https://git-scm.com/) installed, you can easily install the
[atk-sc3 Quark](https://github.com/ambisonictoolkit/atk-sc3) directly by
running the following line of code in SuperCollider:

Quarks.install("https://github.com/ambisonictoolkit/atk-sc3.git");


sc3-plugins
-----------

Compiled releases are available from the
The ATK's compiled UGen component releases are available from the
[sc3-plugins](https://github.com/supercollider/sc3-plugins/releases)
releases page.

Place the downloaded `SC3plugins` folder in your `Extensions` folder. On Mac OS X, this resolves to:
Place the downloaded `SC3plugins` folder in your `Extensions` folder. On Mac
OS X, this resolves to:

~/Library/Application Support/SuperCollider/Extensions

You may need to create the `Extensions` folder if it does not already exist.

On other platforms, you can find where this is by running the following line of code in SuperCollider:
On other platforms, you can find where this is by running the following line of
code in SuperCollider:

(
(
// post the directory in which to move the SC3Plugins folder
Platform.userExtensionDir.postln;
)
Expand All @@ -75,26 +95,21 @@ On other platforms, you can find where this is by running the following line of
Platform.userExtensionDir.openOS;
)

Additionally, the SuperCollider3 version of the ATK has a number of
dependencies. Please install the following:

* Install the [MathLib Quark](https://github.com/supercollider-quarks/MathLib)
most simply by running `Quarks.gui` in the SuperCollider IDE. Further install
options and information on Quarks can be found in SuperCollider's Help system.
See [Using Quarks](http://doc.sccode.org/Guides/UsingQuarks.html) and also the
[supercollider-quarks](https://github.com/supercollider-quarks/quarks) GitHub page.
* Install the [FileLog Quark](https://github.com/supercollider-quarks/FileLog)
Kernels & Recordings
--------------------

Additionally, the SuperCollider3 version of the ATK has further dependencies:

* Download and install [ATK Kernels](http://www.ambisonictoolkit.net/download/kernels/).
* Download and install [ATK Sound File Example Recordings](http://www.ambisonictoolkit.net/download/recordings/).

__NOTE:__ The ATK requires SuperCollider3 version 3.5 or later. Download the latest version [here](http://supercollider.github.io/download), or fork the source code at [GitHub](http://supercollider.github.io/).


 

### Source code

You can build ATK for SuperCollider from the [sc3-plugins](https://github.com/supercollider/sc3-plugins) source-code.
You can build the ATK for SuperCollider UGen components from the [sc3-plugins](https://github.com/supercollider/sc3-plugins) source-code.


 
Expand Down Expand Up @@ -158,7 +173,12 @@ Ambisonic Toolkit.
List of Changes
---------------

Unreleased
Unreleased 3.9.0

* Refactoring:
* Quark-ify: classes, extension methods & documentation moved to
[atk-sc3 Quark](https://github.com/ambisonictoolkit/atk-sc3). UGens remain
in [sc3-plugins](https://github.com/supercollider/sc3-plugins).

* Issue fixes:
* Class library: fix inline warnings
Expand Down Expand Up @@ -249,14 +269,16 @@ Version 3.5

__A note on the ATK's version numbers__: As part of the
[sc3-plugins](https://github.com/supercollider/sc3-plugins) project, the
SuperCollider3 ATK's versioning is synced to the release numbers assigned to
[sc3-plugins releases](https://github.com/supercollider/sc3-plugins/releases).
As a result, at this time the versioning for
[atk-sc3](https://github.com/ambisonictoolkit/atk-sc3) does not adhere to the
SuperCollider3 ATK's versioning for UGen components is synced to the release
numbers assigned to
[sc3-plugins releases](https://github.com/supercollider/sc3-plugins/releases). A
separate versioning trajectory for
[atk-sc3](https://github.com/ambisonictoolkit/atk-sc3) adheres to the
familiar system known as [Semantic Versioning](http://semver.org/).

As SuperCollider3's plugin system continues to develop, we expect to adopt
[Semantic Versioning](http://semver.org/) when it is possible to do so.
[Semantic Versioning](http://semver.org/) for all components when it is possible
to do so.


 
Expand All @@ -268,7 +290,8 @@ Credits

 

Copyright the ATK Community, Joseph Anderson, and Joshua Parmenter, 2011, 2016.
Copyright the ATK Community, Joseph Anderson, and Joshua Parmenter, 2011,
2016-17.

* J Anderson : [[e-mail]](mailto:j.anderson[at]ambisonictoolkit.net)
* J Parmenter : [[e-mail]](mailto:j.parmenter[at]ambisonictoolkit.net)
Expand All @@ -286,8 +309,10 @@ are copyright the Ambisonic Toolkit Community and Joseph Anderson,
Contributors
------------

Unreleased
Unreleased 3.9.0
* Joseph Anderson (@joslloand)
* Julian Rohrhuber (@telephon)
* Michael McCrea (@mtmccrea)

Version 3.8.0
* Daniel Peterson (@dmartinp)
Expand Down

0 comments on commit 9a7ac21

Please sign in to comment.