github/scratch-render
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update documentation in README

Browse Source
This commit is contained in:
Andrew Sliwinski
2016-08-08 14:23:25 -04:00
parent 47b5d07497
commit b8cc5f5245
1 changed files with 46 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
README.md
View File

@@ -1,13 +1,52 @@
## scratch-render-webgl
## scratch-render
#### WebGL-based rendering engine for Scratch 3.0
[![Build Status](https://travis-ci.com/LLK/scratch-render-webgl.svg?token=zzz&branch=develop)](https://travis-ci.com/LLK/scratch-render-webgl)
[![Build Status](https://travis-ci.org/LLK/scratch-render.svg?branch=develop)](https://travis-ci.org/LLK/scratch-render)
[![Dependency Status](https://david-dm.org/LLK/scratch-render.svg)](https://david-dm.org/LLK/scratch-render)
[![devDependency Status](https://david-dm.org/LLK/scratch-render/dev-status.svg)](https://david-dm.org/LLK/scratch-render#info=devDependencies)
## Installation
```bash
npm install scratch-render-webgl
npm install https://github.com/LLK/scratch-render.git
```
## Setup
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Scratch WebGL rendering demo</title>
</head>
<body>
<canvas id="myStage"></canvas>
<canvas id="myDebug"></canvas>
</body>
</html>
```
```js
var canvas = document.getElementById('myStage');
var debug = document.getElementById('myDebugElement');
// Instantiate the renderer
var renderer = new require('scratch-render')(canvas);
// Connect to debug canvas
renderer.setDebugCanvas(document.getElementById('debug-canvas'));
// Start drawing
function drawStep() {
renderer.draw();
requestAnimationFrame(drawStep);
}
drawStep();
// Connect to worker (see "playground" example)
var worker = new Worker('worker.js');
renderer.connectWorker(worker);
```
## Standalone Build
```bash
@@ -15,9 +54,9 @@ make build
```
```html
<script src="/path/to/render-webgl.js"></script>
<script src="/path/to/render.js"></script>
<script>
var renderer = new window.RenderWebGL();
var renderer = new window.RenderWebGLLocal();
// do things
</script>
```
@@ -27,10 +66,5 @@ make build
make test
```
```bash
make coverage
```
```bash
make benchmark
```
## Donate
We provide [Scratch](https://scratch.mit.edu) free of charge, and want to keep it that way! Please consider making a [donation](https://secure.donationpay.org/scratchfoundation/) to support our continued engineering, design, community, and resource development efforts. Donations of any size are appreciated. Thank you!