From 42e2531e8d27970d59a0e3067d2fcc9a4c6d77df Mon Sep 17 00:00:00 2001 From: Felix Roos Date: Wed, 13 Apr 2022 00:09:04 +0200 Subject: [PATCH] readme additions --- README.md | 44 +++++++++++++++++++++++--------------------- 1 file changed, 23 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index fb0ab91f..876e76fc 100644 --- a/README.md +++ b/README.md @@ -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. -Try it here: https://strudel.tidalcycles.org/ +- Try it here: +- Tutorial: +- Technical Blog Post: -Tutorial: https://strudel.tidalcycles.org/tutorial/ +## Running Locally -## Local development - -Run the REPL locally: +After cloning the project, you can run the REPL locally: ```bash -npm install -npx lerna bootstrap -cd repl -npm install -npm run start +npm run setup +npm run repl ``` -## 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 -npx lerna publish -``` +- [`core`](./packages/core/): tidal pattern engine +- [`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 -There is a #strudel channel on the TidalCycles discord: https://discord.com/invite/HGEdXmRkzT +There is a #strudel channel on the TidalCycles discord: -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: -The discord and forum is shared with the haskell (tidal) and python (vortex) siblings of this project. \ No newline at end of file +The discord and forum is shared with the haskell (tidal) and python (vortex) siblings of this project.