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 c13e234 commit 6575c9f
Showing 1 changed file with 25 additions and 19 deletions.
44 changes: 25 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,32 @@ nudel is a public jam space, made by [pastagang](https://www.pastagang.cc/)
everyone is in the same room. anyone is encouraged to join in!\
tip: press alt + enter to run code.

##
## 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/). the site will always point to the "pastagang" room, maximizing the chance for a jam to start.

## contributing

everyone can change nudel

to become an admin of nudel, [create an issue](https://github.com/pastagang/nudel/issues/new/choose) and ask to get added.

<br>

let's aim to be hierarchy free, so anyone is welcomed to change things they see fit.\
let's _not_ have a [bdfl](https://en.wikipedia.org/wiki/Benevolent_dictator_for_life), 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](https://pastagang.cc/paper).

<br>

# Technical stuff

it's a mashup of existing free & open source projects:
welcome to the spaghetti of nudel

## what nudel is made of

nudel a mashup of existing free & open source projects:

- [flok](https://github.com/munshkr/flok/) for collab coding
- [strudel](https://github.com/tidalcycles/strudel) for sound
Expand All @@ -19,10 +42,6 @@ it's a mashup of existing free & open source projects:

if you enjoy nudel, 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/). the site will always point to the "pastagang" room, maximizing the chance for a jam to start.

## running locally

0. make sure you have [node.js](https://nodejs.org/en/download) installed
Expand All @@ -38,19 +57,6 @@ any changes to `main` will be deployed immediately to [nudel.cc](https://nudel.c

if you break something, that's ok. (we can use [todepond.cool/flok](https://www.todepond.cool/flok) as a backup)

## contributing

everyone can change nudel

to become an admin of nudel, [create an issue](https://github.com/pastagang/nudel/issues/new/choose) and ask to get added.

<br>

let's aim to be hierarchy free, so anyone is welcomed to change things they see fit.\
let's _not_ have a [bdfl](https://en.wikipedia.org/wiki/Benevolent_dictator_for_life), 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.\
Expand Down

0 comments on commit 6575c9f

Please sign in to comment.