Skip to content

Commit

Permalink
readme wip
Browse files Browse the repository at this point in the history
  • Loading branch information
starakaj committed Feb 25, 2022
1 parent 744d6da commit f05d776
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 2,654 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,27 @@

This example shows you how to add dynamic audio to a web page, using the JavaScript source code export feature of RNBO, part of [Max 8](https://cycling74.com/products/max) made by [Cycling '74](https://cycling74.com).

This repository uses [Node](https://nodejs.org/en/) to launch a simple web server to make your web page available locally. For more on why this is necessary, see (Why a local server?)[##-Why-a-local-server?]
This repository uses [Node](https://nodejs.org/en/) to launch a simple web server to make your web page available locally. For more on why this is necessary, see [Why a local server?](#why-a-local-server)

## Requirements
## Prerequisites

In order to run this example, you'll need `node`, `npm`, and access to the command line. Start by installing `node` if you don't already have it.

```
https://nodejs.org/en/download/
```

Then, open up your terminal (Terminal.app on Mac, \<tbd> on Windows) and navigate to this directory.
## File structure

The source code of the web application is in the `js/` directory. This directory contains the file `app.js`, which does all the work of loading and connecting your RNBO patch. There is also a file `guardrails.js`, which simply tries to provide some clear feedback if you're not running this example in the intended way.

Some notable files/directories:

| Location | Explanation |
| --------------------------------- | ------------- |
| export/ | The directory into which you should export your RNBO code |
| js/ | Source for the project, edit it however you like |
| index.html | The web page itself |

## Running the server

Expand Down
Empty file added export/.gitkeep
Empty file.
1 change: 0 additions & 1 deletion export/patch.export.json

This file was deleted.

24 changes: 0 additions & 24 deletions export/rnbopackage.json

This file was deleted.

Binary file added img/use-this-template-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit f05d776

Please sign in to comment.