elias/strudel-docker
1
0
Fork 0
mirror of https://github.com/eliasstepanik/strudel-docker.git synced 2026-01-24 03:58:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

readme additions

Browse Source
This commit is contained in:
Felix Roos 2022-04-13 00:09:04 +02:00
parent 171f845069
commit 42e2531e8d
1 changed files with 23 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -4,40 +4,42 @@
An experiment in making a [Tidal](https://github.com/tidalcycles/tidal/) using web technologies. This is unstable software, please tread carefully. An experiment in making a [Tidal](https://github.com/tidalcycles/tidal/) using web technologies. This is unstable software, please tread carefully.
Try it here: https://strudel.tidalcycles.org/ - Try it here: <https://strudel.tidalcycles.org/>
- Tutorial: <https://strudel.tidalcycles.org/tutorial/>
- Technical Blog Post: <https://loophole-letters.vercel.app/strudel>
Tutorial: https://strudel.tidalcycles.org/tutorial/ ## Running Locally
## Local development After cloning the project, you can run the REPL locally:
Run the REPL locally:
```bash ```bash
npm install npm run setup
npx lerna bootstrap npm run repl
cd repl
npm install
npm run start
``` ```
## Publish Packages ## Using Strudel In Your Project
To publish, just run: There are multiple npm packages you can use to use strudel, or only parts of it, in your project:
```sh - [`core`](./packages/core/): tidal pattern engine
npx lerna publish - [`mini`](./packages/mini): mini notation parser + core binding
``` - [`eval`](./packages/eval): user code evaluator. syntax sugar + highlighting
- [`tone`](./packages/tone): bindings for Tone.js instruments and effects
- [`osc`](./packages/osc): bindings to communicate via OSC
- [`midi`](./packages/midi): webmidi bindings
- [`tonal`](./packages/tonal): tonal functions
- [`xen`](./packages/xen): microtonal / xenharmonic functions
This will publish all packages that changed since the last version. Click on the package names to find out more about each one.
## Style ## Contributing
For now, please try to copy the style of surrounding code. VS Code users can install the 'prettier' add-on which will use the .prettierrc configuration file for automatic formatting. There are many ways to contribute to this project! See [contribution guide](./CONTRIBUTING.md).
## Community ## Community
There is a #strudel channel on the TidalCycles discord: https://discord.com/invite/HGEdXmRkzT There is a #strudel channel on the TidalCycles discord: <https://discord.com/invite/HGEdXmRkzT>
You can also ask questions and find related discussions on the tidal club forum: https://club.tidalcycles.org/ You can also ask questions and find related discussions on the tidal club forum: <https://club.tidalcycles.org/>
The discord and forum is shared with the haskell (tidal) and python (vortex) siblings of this project. The discord and forum is shared with the haskell (tidal) and python (vortex) siblings of this project.