scratch-vm/README.md

45 lines
477 B
Markdown
Raw Normal View History

2016-04-08 13:10:37 -04:00
## scratch-vm
## Installation
```bash
npm install scratch-vm
```
2016-04-18 17:20:30 -04:00
## Setup
2016-04-08 13:10:37 -04:00
```js
2016-04-18 17:20:30 -04:00
var VirtualMachine = require('scratch-vm');
var vm = new VirtualMachine();
2016-04-08 13:10:37 -04:00
2016-04-18 17:20:30 -04:00
// Block events
// UI events
// Listen for events
```
## Standalone Build
```bash
make build
```
```html
<script src="/path/to/vm.js"></script>
<script>
var vm = new window.VirtualMachine();
// do things
</script>
2016-04-08 13:10:37 -04:00
```
## Testing
```bash
make test
```
```bash
make coverage
```
```bash
make benchmark
```