Difference between revisions of "MacOS installation"

From TidalCycles userbase
Jump to: navigation, search
 
(36 intermediate revisions by 5 users not shown)
Line 1: Line 1:
= Manual Installation =
+
<languages />
 +
<translate>
 +
= Easy Installation = <!--T:1-->
  
== Prerequisites ==
+
<!--T:29-->
 +
For an easy, hands-off install, try [https://github.com/tidalcycles/tidal-bootstrap/blob/master/README.md tidal-bootstrap] instead of the manual instructions below.
  
The following are required:
+
= Manual Installation = <!--T:6-->
  
* [https://www.haskell.org/platform/ Haskell Platform] - the Full platform is recommended. Advanced users may try using the Core platform.
+
== Prerequisites == <!--T:7-->
* [https://atom.io/ Atom Editor]
+
 
* [http://supercollider.github.io/download SuperCollider] (version 3.7 or later)
+
=== Required Prerequisites=== <!--T:8-->
 +
 
 +
<!--T:9-->
 +
Before installing Tidal, make sure the following are installed first:
 +
 
 +
<!--T:10-->
 +
* [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]])
 +
* [http://supercollider.github.io/download SuperCollider] (pick the latest version)
 
* [https://git-scm.com/ Git]
 
* [https://git-scm.com/ Git]
  
The following are optional:
+
=== Optional Prerequisites === <!--T:11-->
  
 +
<!--T:12-->
 +
The following is optional, but highly recommended:
 +
 +
<!--T:13-->
 
* [https://supercollider.github.io/sc3-plugins/ 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.
 
* [https://supercollider.github.io/sc3-plugins/ 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 ==
+
== Install TidalCycles == <!--T:14-->
 +
 
 +
<!--T:15-->
 +
In a terminal window, we will add the path to our GHC installation to a file that is executed by our terminal every time it loads.
 +
 
 +
For macOS 10.14 or before, the terminal uses bash, so the file we need to modify is .bashrc:
  
From a terminal, type and run these two commands:
+
<!--T:16-->
 +
<source>
 +
. "$HOME/.ghcup/env"
 +
echo '. $HOME/.ghcup/env' >> "$HOME/.bashrc"
 +
</source>
  
 +
For macOS10.15 Catalina, the terminal uses zsh, so the file we need to modify is .zshrc:
 +
 +
<!--T:17-->
 +
<source>
 +
. "$HOME/.ghcup/env"
 +
echo '. $HOME/.ghcup/env' >> "$HOME/.zshrc"
 +
</source>
 +
 +
After this, we will use cabal to first update it package directory, and then to install the TidalCycles library. We will also run these two commands every time we want to update our TidalCycles library to the latest version.
 +
 +
<!--T:18-->
 +
<source>
 
  cabal update
 
  cabal update
  cabal install tidal
+
  cabal install tidal --lib
 +
</source>
  
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.
+
<!--T:19-->
 +
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 ==
+
== Install SuperDirt == <!--T:18-->
  
 +
<!--T:19-->
 
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:
  
include("SuperDirt")
+
<!--T:20-->
 
+
<source lang="plaintext">
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:
+
Quarks.checkForUpdates({Quarks.install("SuperDirt", "v1.7.2"); thisProcess.recompile()})
 +
</source>
  
... the class library may have to be recompiled.
+
<!--T:21-->
-> SuperDirt
+
Run the code by clicking on it, to make sure the cursor is on this line, then hold down Shift and press Enter.
  
After it has completed, you will need to restart SuperCollider (or alternatively, recompile the class library via the “Language” menu).
+
<!--T:22-->
 +
It'll take a while to install. You'll see something like the following:
  
== Install Atom Extension ==
+
<!--T:30-->
 +
<source lang="plaintext">
 +
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:)
 +
...
  
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.
+
<!--T:31-->
 +
*** Welcome to SuperCollider 3.10.0. *** For help press Ctrl-D.
 +
</source>
  
== Test Your Installation ==
+
== Install Atom Extension == <!--T:24-->
  
Now you are ready to [[start_tidalcycles_and_superdirt_for_the_first_time|Start TidalCycles and SuperDirt for the first time]].
+
<!--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.  
  
= Automated Installation with TidalBootstrap =
+
<!--T:32-->
 +
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>
  
You can download TidalBootstrap at  https://tidalcycles.github.io/tidal-bootstrap
+
<!--T:33-->
 +
Once that’s all installed and configured, restart atom.
  
Please note: There are several reports that tidal-bootstrap currently only works if you install the 8.2.1 version of the haskell platform first. You can  
+
== Install VS Code Extension == <!--T:28-->
download that from https://www.haskell.org/platform/download/8.2.1/Haskell%20Platform%208.2.1%20Full%2064bit-signed.pkg
+
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.
  
Here’s a video demonstrating the tidal-bootstrap install process: https://www.youtube.com/watch?v=dJTfGv2sT-w
+
== Test Your Installation == <!--T:26-->
  
Once that’s done, it’s time to [[start_tidalcycles_and_superdirt_for_the_first_time|Start TidalCycles and SuperDirt for the first time]].
+
<!--T:27-->
 +
Now you are ready to [[Start tidalcycles and superdirt for the first time|Start TidalCycles and SuperDirt for the first time]].
 +
</translate>

Latest revision as of 12:03, 29 January 2021

Other languages:
British English • ‎Deutsch • ‎English • ‎español

Easy Installation

For an easy, hands-off install, try tidal-bootstrap instead of the manual instructions below.

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, we will add the path to our GHC installation to a file that is executed by our terminal every time it loads.

For macOS 10.14 or before, the terminal uses bash, so the file we need to modify is .bashrc:

 . "$HOME/.ghcup/env"
 echo '. $HOME/.ghcup/env' >> "$HOME/.bashrc"

For macOS10.15 Catalina, the terminal uses zsh, so the file we need to modify is .zshrc:

 . "$HOME/.ghcup/env"
 echo '. $HOME/.ghcup/env' >> "$HOME/.zshrc"

After this, we will use cabal to first update it package directory, and then to install the TidalCycles library. We will also run these two commands every time we want to update our TidalCycles library to the latest version.

 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.7.2"); 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.