Skip to content

Commit

Permalink
Update faustsnippets.js.
Browse files Browse the repository at this point in the history
  • Loading branch information
sletz committed Jan 12, 2025
1 parent 79ddd89 commit 2b04631
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 4 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Faust Editor
The online [Faust Editor](https://fausteditor.grame.fr) can be used to _edit_, _compile_ and _run_ Faust code from any recent Web Browser with [WebAssembly](http://webassembly.org) support. It works completely on the client side and it is therefore very convenient for situations with many simultaneous users (workshops, classrooms, etc.). It embeds the latest version of the Faust compiler with an efficient webassembly backend and offers polyphonic MIDI support.

The online [Faust Editor](https://fausteditor.grame.fr) can be used to _edit_, _compile_ and _run_ Faust code from any Web Browser with [WebAssembly](http://webassembly.org) support. It works completely on the client side and it is therefore very convenient for situations with many simultaneous users (workshops, classrooms, etc.). It embeds the Faust compiler with an efficient webassembly backend and offers polyphonic MIDI support.

![](/images/editor-help.png)

Expand All @@ -21,25 +22,37 @@ The recommended browsers are the latest versions of Firefox and Chrome.
## Development

### Notes
We use [Vite](https://vitejs.dev/) for development mode and builds. Dependencies include [CodeMirror](https://codemirror.net/5/) for providing an editor, [FaustWasm](https://github.com/Fr0stbyteR/faustwasm) for compiling Faust client-side, and [FaustUI](https://github.com/Fr0stbyteR/faust-ui) for rendering widgets.

We use [Vite](https://vitejs.dev/) for development mode and builds. Dependencies include [CodeMirror](https://codemirror.net/5/) for providing an editor, [FaustWasm](https://github.com/grame-cncm/faustwasm) for compiling Faust DSP client-side, and [FaustUI](https://github.com/Fr0stbyteR/faust-ui) for rendering GUI widgets.

### Generating the faustsnippets

The `gFaustLibSnippets` content in the `src/codemirror/mode/faust/faustsnippets.js` file has to be manually updated with the result of the `faust2atomsnippets -s *.lib` command done in the Faust libraries folder.

### Setup

Clone and enter the repository, then run:

```bash
npm install
```

### 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

Generates output in `dist/`. To view locally, run:

``` shell
cd dist
python -m http.server
Expand Down
Loading

0 comments on commit 2b04631

Please sign in to comment.