add install commands

This commit is contained in:
Felix Roos 2022-03-27 22:17:07 +02:00
parent c4d14594ce
commit 73996997e5
7 changed files with 42 additions and 0 deletions

View file

@ -1,3 +1,9 @@
# @strudel.cycles/core # @strudel.cycles/core
This package contains the bare essence of strudel. This package contains the bare essence of strudel.
## Install
```sh
npm i @strudel.cycles/core --save
```

View file

@ -3,6 +3,12 @@
This package contains the strudel code transformer and evaluator. This package contains the strudel code transformer and evaluator.
It allows creating strudel patterns from input code that is optimized for minimal keystrokes and human readability. It allows creating strudel patterns from input code that is optimized for minimal keystrokes and human readability.
## Install
```sh
npm i @strudel.cycles/eval --save
```
## Dev Notes ## Dev Notes
shift-traverser is currently monkey patched because its package.json uses estraverse@^4.2.0, shift-traverser is currently monkey patched because its package.json uses estraverse@^4.2.0,

View file

@ -1,3 +1,9 @@
# @strudel.cycles/midi # @strudel.cycles/midi
This package adds midi functionality to strudel Patterns. This package adds midi functionality to strudel Patterns.
## Install
```sh
npm i @strudel.cycles/midi --save
```

View file

@ -1,3 +1,9 @@
# @strudel.cycles/mini # @strudel.cycles/mini
This package contains the mini notation parser and pattern generator. This package contains the mini notation parser and pattern generator.
## Install
```sh
npm i @strudel.cycles/mini --save
```

View file

@ -1,3 +1,9 @@
# @strudel.cycles/tonal # @strudel.cycles/tonal
This package adds tonal / harmonic functions to strudel Patterns. This package adds tonal / harmonic functions to strudel Patterns.
## Install
```sh
npm i @strudel.cycles/tonal --save
```

View file

@ -2,6 +2,12 @@
This package adds Tone.js functions to strudel Patterns. This package adds Tone.js functions to strudel Patterns.
## Install
```sh
npm i @strudel.cycles/tone --save
```
## Dev Notes ## Dev Notes
- `@tonejs/piano` has peer dependency on `webmidi@^2.5.1`! A newer version of webmidi will break. - `@tonejs/piano` has peer dependency on `webmidi@^2.5.1`! A newer version of webmidi will break.

View file

@ -1,3 +1,9 @@
# @strudel.cycles/xen # @strudel.cycles/xen
This package adds xenharmonic / microtonal functions to strudel Patterns. This package adds xenharmonic / microtonal functions to strudel Patterns.
## Install
```sh
npm i @strudel.cycles/xen --save
```