Update README

grame-cncm · Jul 13, 2023 · 7c8e57d · sletz · Jul 13, 2023 · 7c8e57d
1 parent 8551311
commit 7c8e57d
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 30 deletions.
diff --git a/Makefile b/Makefile
diff --git a/README.md b/README.md
@@ -2,44 +2,43 @@
 
 Faust playground is a Web platform designed to enable children to learn basic audio programming in a simple and graphic way. In particular, it allows them to develop musical instruments for Android smartphones.
 
+## Useful links
 
-## To test it:
+- [https://faustplayground.grame.fr](https://faustplayground.grame.fr): official FaustPlayground website
+- [https://github.com/grame-cncm/faustplayground](https://github.com/grame-cncm/faustplayground): GitHub repository
 
-To run in development mode:
-``` shell
+## Development
+
+### Notes
+This project uses [Vite](https://vitejs.dev/) for development mode and builds and [FaustWasm](https://github.com/Fr0stbyteR/faustwasm) for compiling Faust in the browser.
+
+### Setup
+Clone and enter the repository, then run:
+```bash
 npm install
-npm run dev
 ```
 
-To build and test:
+### Run in development mode (automatic reloading)
+```bash
+npm run dev
+```
+Then press <kbd>o</kbd> to open in a browser.
 
+### Build
 ``` shell
 npm run build
+```
+Generates output in `dist/`. To view locally, run
+``` shell
 cd dist
 python -m http.server
 ```
 
-Then open:
-
-	http://127.0.0.1:8000/
-
-## To regenerate examples (in json/ folder)
-
+### To create examples (in `public/json/`)
 - create a patch in the platform
 - possibly rename it using the the "Edit" button
 - save it (regular or precompiled version) using the "Save" button
-- rename it with a .json file ending
-
-## To add new Faust modules
-
-In the `faust-modules` folder, add your .dsp files to the `effects` or `generators` folder. Then update `faust-modules/index.json` by hand.
-
-## To rebuild the JavaScript
-
-- install `tsc`: `npm i -g typescript`
-- run `make compile`
-
-## Useful links
+- rename it with a `.json` file extension
 
-- [https://faustplayground.grame.fr](https://faustplayground.grame.fr): the official link on the FaustPlayground website.
-- [https://github.com/grame-cncm/faustplayground](https://github.com/grame-cncm/faustplayground): the github repository
+### To add new Faust modules
+In `public/faust-modules/`, add your .dsp files to `effects/` or `generators/`. Then update `index.json` to include the paths to your new modules.