diff --git a/README.md b/README.md index 12ee85035..0d576ac6d 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,3 @@ # strudel -[![Strudel test status](https://github.com/tidalcycles/strudel/actions/workflows/test.yml/badge.svg)](https://github.com/tidalcycles/strudel/actions) [![DOI](https://zenodo.org/badge/450927247.svg)](https://doi.org/10.5281/zenodo.6659278) - -An experiment in making a [Tidal](https://github.com/tidalcycles/tidal/) using web technologies. This software is a bit more stable now, but please continue to tread carefully. - -- Try it here: -- Docs: -- Technical Blog Post: -- 1 Year of Strudel Blog Post: -- 2 Years of Strudel Blog Post: - -## Running Locally - -After cloning the project, you can run the REPL locally: - -1. Install [Node.js](https://nodejs.org/) -2. Install [pnpm](https://pnpm.io/installation) -3. Install dependencies by running the following command: - ```bash - pnpm i - ``` -4. Run the development server: - ```bash - pnpm dev - ``` - -## Using Strudel In Your Project - -This project is organized into many [packages](./packages), which are also available on [npm](https://www.npmjs.com/search?q=%40strudel). - -Read more about how to use these in your own project [here](https://strudel.cc/technical-manual/project-start). - -You will need to abide by the terms of the [GNU Affero Public Licence v3](LICENSE.md). As such, Strudel code can only be shared within free/open source projects under the same license -- see the license for details. - -Licensing info for the default sound banks can be found over on the [dough-samples](https://github.com/felixroos/dough-samples/blob/main/README.md) repository. - -## Contributing - -There are many ways to contribute to this project! See [contribution guide](./CONTRIBUTING.md). - - - - - -Made with [contrib.rocks](https://contrib.rocks). - -## Community - -There is a #strudel channel on the TidalCycles discord: - -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. +Moving to https://codeberg.org/uzu/strudel