Difference between revisions of "MacOS installation"

From TidalCycles userbase
Jump to: navigation, search
 
(16 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
= Automated Installation with TidalBootstrap = <!--T:1-->
 
= Automated Installation with TidalBootstrap = <!--T:1-->
  
<!--T:2-->
+
We are working on a simple bash script that (hopefully) works for a hands-off install. If you're feeling brave, you're welcome to [https://github.com/tidalcycles/tidal-bootstrap/blob/master/README.md try it out here].
You can download [https://tidalcycles.github.io/tidal-bootstrap Tidal-Bootstrap here]. 
 
 
 
<!--T:3-->
 
Please note: There are several reports that tidal-bootstrap is currently not working. If you have issues with it, or manage to get it to work, [https://github.com/tidalcycles/Tidal/issues/526 please share your experience here]!
 
 
 
<!--T:4-->
 
Here’s a [https://www.youtube.com/watch?v=dJTfGv2sT-w video demonstrating the tidal-bootstrap install process].
 
 
 
<!--T:5-->
 
Once that’s done, it’s time to [[Start tidalcycles and superdirt for the first time|Start TidalCycles and SuperDirt for the first time]].
 
  
 
= Manual Installation = <!--T:6-->
 
= Manual Installation = <!--T:6-->
Line 24: Line 14:
  
 
<!--T:10-->
 
<!--T:10-->
* [https://www.haskell.org/platform/ Haskell Platform] - '''the 'full' version is strongly recommended'''.
+
* [https://www.haskell.org/ghcup/ Haskell] (via ghcup)
 
* [https://atom.io/ Atom Editor]  (if you don't like the atom editor for some reason, please check out the [[List of tidal editors|list of alternatives]])
 
* [https://atom.io/ Atom Editor]  (if you don't like the atom editor for some reason, please check out the [[List of tidal editors|list of alternatives]])
 
* [http://supercollider.github.io/download SuperCollider] (pick the latest version)
 
* [http://supercollider.github.io/download SuperCollider] (pick the latest version)
Line 32: Line 22:
  
 
<!--T:12-->
 
<!--T:12-->
The following is optional, but recommended:
+
The following is optional, but highly recommended:
  
 
<!--T:13-->
 
<!--T:13-->
Line 40: Line 30:
  
 
<!--T:15-->
 
<!--T:15-->
From a terminal, type and run these two commands ''(ignoring any complaints that cabal has of 'legacy v1 style of usage')'':
+
In a terminal window, paste in these lines:
  
 
  <!--T:16-->
 
  <!--T:16-->
cabal update
+
<source>
  cabal install tidal
+
. "$HOME/.ghcup/env"
 +
echo '. $HOME/.ghcup/env' >> "$HOME/.bashrc"
 +
cabal update
 +
  cabal install tidal --lib
 +
</source>
  
 
<!--T:17-->
 
<!--T:17-->
If you've never installed TidalCycles before, then the <code>cabal install tidal</code> step may take some time. At the end of the command output, it should say <code>Installed tidal-x.x.x</code> (where x.x.x is the latest version number) without any errors.
+
If you've never installed TidalCycles before, then the <code>cabal install tidal --lib</code> step may take some time. At the end of the command output, it should say <code>Installed tidal-x.x.x</code> (where x.x.x is the latest version number) without any errors.
  
 
== Install SuperDirt == <!--T:18-->
 
== Install SuperDirt == <!--T:18-->
Line 54: Line 48:
 
Start SuperCollider, and in the editor window paste in the following line of code:
 
Start SuperCollider, and in the editor window paste in the following line of code:
  
    <!--T:20-->
+
<!--T:20-->
Quarks.checkForUpdates(); Quarks.install("SuperDirt", "v1.0")
+
Quarks.checkForUpdates({Quarks.install("SuperDirt", "v1.1.1"); thisProcess.recompile()})
  
 
<!--T:21-->
 
<!--T:21-->
Run the code by clicking on it, to make sure the cursor is on this line, then hold down Shift and press Enter. This will download SuperDirt and you will see it has completed when the Post Window displays:
+
Run the code by clicking on it, to make sure the cursor is on this line, then hold down Shift and press Enter.
  
<!--T:22-->
+
<!--T:22-->
... the class library may have to be recompiled.
+
It'll take a while to install. You'll see something like the following:
-> SuperDirt
 
  
<!--T:23-->
+
<source lang="plaintext">
After it has completed, you will need to restart SuperCollider (or alternatively, recompile the class library via the “Language” menu).
+
Installing SuperDirt
 +
Installing Vowel
 +
Vowel installed
 +
Installing Dirt-Samples
 +
Dirt-Samples installed
 +
SuperDirt installed
 +
compiling class library...
 +
...
 +
(then some blah blah, and finally, something like:)
 +
...
 +
 
 +
*** Welcome to SuperCollider 3.10.0. *** For help press Ctrl-D.
 +
</source>
  
 
== Install Atom Extension == <!--T:24-->
 
== Install Atom Extension == <!--T:24-->
  
 
<!--T:25-->
 
<!--T:25-->
Start Atom, and install the TidalCycles plugin. You can find it via the menus under edit > settings > install, then typing “tidalcycles” into the search box. Once that’s installed, restart atom.
+
Start Atom, and install the TidalCycles plugin. You can find it via the menus under edit > settings > install, then typing “tidalcycles” into the search box.  
 +
 
 +
Once it's installed, you'll need to change the "ghci path" setting for the tidalcycles package to the following: <source inline>~/.ghcup/bin/ghci</source>
 +
 
 +
Once that’s all installed and configured, restart atom.
 +
 
 +
== Install VS Code Extension == <!--T:24-->
 +
Start VS Code, and install the TidalCycles extension by searching the extensions marketplace.
 +
You can follow the instructions from [https://marketplace.visualstudio.com/items?itemName=tidalcycles.vscode-tidalcycles here] to ensure you know how to use it correctly.
  
 
== Test Your Installation == <!--T:26-->
 
== Test Your Installation == <!--T:26-->

Latest revision as of 16:33, 15 October 2019

Automated Installation with TidalBootstrap

We are working on a simple bash script that (hopefully) works for a hands-off install. If you're feeling brave, you're welcome to try it out here.

Manual Installation

Prerequisites

Required Prerequisites

Before installing Tidal, make sure the following are installed first:

Optional Prerequisites

The following is optional, but highly recommended:

  • SC3 Plugins - you may need the SuperCollider sc3-plugins if you want to use any of the synths included in SuperDirt. Most of the examples in the documentation will still work, so you could skip this step and return to it later.

Install TidalCycles

In a terminal window, paste in these lines:

 . "$HOME/.ghcup/env"
 echo '. $HOME/.ghcup/env' >> "$HOME/.bashrc"
 cabal update
 cabal install tidal --lib

If you've never installed TidalCycles before, then the cabal install tidal --lib step may take some time. At the end of the command output, it should say Installed tidal-x.x.x (where x.x.x is the latest version number) without any errors.

Install SuperDirt

Start SuperCollider, and in the editor window paste in the following line of code:

Quarks.checkForUpdates({Quarks.install("SuperDirt", "v1.1.1"); thisProcess.recompile()})

Run the code by clicking on it, to make sure the cursor is on this line, then hold down Shift and press Enter.

It'll take a while to install. You'll see something like the following:

Installing SuperDirt
Installing Vowel
Vowel installed
Installing Dirt-Samples
Dirt-Samples installed
SuperDirt installed
compiling class library...
...
(then some blah blah, and finally, something like:)
...

*** Welcome to SuperCollider 3.10.0. *** For help press Ctrl-D.

Install Atom Extension

Start Atom, and install the TidalCycles plugin. You can find it via the menus under edit > settings > install, then typing “tidalcycles” into the search box.

Once it's installed, you'll need to change the "ghci path" setting for the tidalcycles package to the following: ~/.ghcup/bin/ghci

Once that’s all installed and configured, restart atom.

Install VS Code Extension

Start VS Code, and install the TidalCycles extension by searching the extensions marketplace. You can follow the instructions from here to ensure you know how to use it correctly.

Test Your Installation

Now you are ready to Start TidalCycles and SuperDirt for the first time.