diff --git a/README.md b/README.md index 34fc9d14..2d24d869 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,3 @@ cd repl npm install npm run start ``` - -## Build - -```bash -cd repl -npm run build -npm run static # <- test static build -``` diff --git a/repl/README.md b/repl/README.md index 0e0df66c..e7fe44e2 100644 --- a/repl/README.md +++ b/repl/README.md @@ -1,6 +1,32 @@ # Strudel REPL -TBD +This is the REPL for Strudel. REPL stands for + +- Read +- Evaluate +- Play! +- Loop + +The REPL is deployed at [strudel.tidalcycles.org](https://strudel.tidalcycles.org/). + +## Run REPL locally + +```bash +# from project root +npm install +npx lerna bootstrap +cd repl +npm install +npm run start +``` + +## Build REPL + +```bash +cd repl +npm run build # <- builds repl + tutorial to ../docs +npm run static # <- test static build +``` ## Dev Notes