Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TodePond authored Jan 15, 2025
1 parent 238bcb2 commit a02ff70
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ it's a mashup of existing free & open source projects:
- [strudel](https://github.com/tidalcycles/strudel) for sound
- [hydra](https://github.com/hydra-synth/hydra-synth) for light

everyone is in the same room. anyone is encouraged to join in!
everyone is in the same room. anyone is encouraged to join in!\
tip: press alt + enter to run code.

if you enjoy this, consider donating to [flok](https://ko-fi.com/munshkr) / [strudel](https://opencollective.com/tidalcycles) / [hydra](https://opencollective.com/hydra-synth)

## background

nudel was born out of [curiosity](https://post.lurk.org/@[email protected]/113739106696182239), to see if flok could be treated as a protocol, where different web clients access the same session. the default frontend for flok is [flok.cc](https://flok.cc/), which supports a lot of live coding languages both web and native, and it's awesome. the first version of nudel was based on the [flok vanilla js example](https://github.com/munshkr/flok/tree/main/packages/example-vanilla-js) and has since then been actively developed by several people around [pastagang](https://www.pastagang.cc/). nudel doesn't support all languages and features of flok.cc, but rather tries to be as simple and lightweight as possible. as of now, only strudel and hydra are supported. the site will always point to the "pastagang" room, maximizing the chance for a jam to start.
nudel was born out of [curiosity](https://post.lurk.org/@[email protected]/113739106696182239), to see if flok could be treated as a protocol, where different web clients access the same session. the default frontend for flok is [flok.cc](https://flok.cc/), which supports a lot of live coding languages both web and native, and it's awesome. the first version of nudel was based on the [flok vanilla js example](https://github.com/munshkr/flok/tree/main/packages/example-vanilla-js) and has since then been actively developed by several people around [pastagang](https://www.pastagang.cc/). the site will always point to the "pastagang" room, maximizing the chance for a jam to start.

## running locally

Expand All @@ -24,8 +24,7 @@ nudel was born out of [curiosity](https://post.lurk.org/@[email protected]/1137391
2. run `npm i` (you can also use `pnpm`)
3. run `npm run dev`

if you need to, disconnect your environment from the public nudel by changing
the hostname to 'localhost' in the main.js. but maybe you shouldn't because nudel is a place, and the maintenance workers can also be seen while people jam?
if you need to, disconnect your environment from the public nudel by changing the hostname to 'localhost' in the main.js. but maybe you shouldn't because nudel is a place, and the maintenance workers can also be seen while people jam?

## publishing

Expand All @@ -36,13 +35,13 @@ while we try to fix it / roll back to an earlier commit.

## contributing

you can create an issue to get invited as a maintainer of this repo.
let's aim to be hierarchy free, so anyone is welcomed to change things they see fit.
let's _not_ have a bdfl, or a small group of people having the last say.
either create a PR, or push directly to main, both is fine.
you can create an issue to get invited as a maintainer of this repo.\
let's aim to be hierarchy free, so anyone is welcomed to change things they see fit.\
let's _not_ have a bdfl, or a small group of people having the last say.\
either create a PR, or push directly to main, both is fine.\
this project has been born out of a jam session, so let's carry that ethos into the code behind the jam.

## flok compatibility

it would be good to stay compatible to flok.cc (and potential other clients), so that people could choose their client.
it would be good to stay compatible to flok.cc (and potential other clients), so that people could choose their client.\
by compatible, i mean the overlapping features should behave similarly, and features that do not overlap should not cause problems.

0 comments on commit a02ff70

Please sign in to comment.