Mirrors/Tone.js
2
0
Fork 0
mirror of https://github.com/Tonejs/Tone.js synced 2024-11-10 05:54:20 +00:00
Code Issues Projects Releases Packages Wiki Activity

README for examples

Browse source
This commit is contained in:
colinmorris 2019-04-11 15:41:28 -04:00
parent 8f08316b41
commit 301c9adbf4
2 changed files with 25 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/CONTRIBUTING.md vendored
View file

@ -4,7 +4,7 @@ If you're looking for ideas for where to get started, consider jumping in on any
### Examples
To contribute examples, please follow the current style of the examples. Add your example's title and file name to `ExampleList.js` file for it to appear in the examples list on the index page.
To contribute examples, please follow the current style of the examples. Add your example's title and file name to `examples/js/ExampleList.json` for it to appear in the examples list on the index page.
### Docs

23
examples/README.md Normal file
View file

@ -0,0 +1,23 @@
These examples use web components (e.g. `<tone-example>`) which are defined in the [Tonejs/ui](https://github.com/Tonejs/ui) repository.
### Running examples locally
Check out the repository, and from the root run:
```
$ npm install
...
$ npm run build
```
Once this is done, you can start a local server with Python:
```
$ python -m SimpleHTTPServer 8000
```
Then, from a browser visit http://localhost:8000/examples. (See also: [installation instructions on the wiki](https://github.com/Tonejs/Tone.js/wiki/Installation#newbie-macos-quickstart-to-get-examples-running))
### Adding examples
To contribute examples, please follow the current style of the examples. Add your example's title and file name to `js/ExampleList.json` file for it to appear in the examples list on the index page. (cf. [CONTRIBUTING.md](https://github.com/Tonejs/Tone.js/blob/dev/.github/CONTRIBUTING.md))