Skip to content

Commit b42254b

Browse files
committed
Add tests section to README
1 parent 6d771a0 commit b42254b

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

README.md

+24-8
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ All mathbox arguments are optional. The following options are available for conf
167167
```javascript
168168
{
169169
// Whether to allow mouse control of the camera.
170-
cameraControls: true,
170+
cameraControls: true,
171171
// Override the class to use for mouse controls.
172172
controlClass: ThreeBox.OrbitControls,
173173
// Whether to show the mouse cursor.
@@ -176,12 +176,12 @@ All mathbox arguments are optional. The following options are available for conf
176176
// Whether to track resizing of the containing element.
177177
elementResize: true,
178178
// Enable fullscreen mode with 'f' (browser support is buggy)
179-
fullscreen: true,
179+
fullscreen: true,
180180
// Render at scaled resolution, e.g. scale 2 is half the width/height.
181181
// Fractional values allowed.
182-
scale: 1,
182+
scale: 1,
183183
// Enable screenshot taking with 'p'
184-
screenshot: true,
184+
screenshot: true,
185185
// Show FPS stats in the corner
186186
stats: true,
187187
}
@@ -264,7 +264,7 @@ Each mathbox scene has an associated viewport. This sets up a specific mathemati
264264

265265
The following viewport types are available:
266266

267-
__Cartesian__
267+
__Cartesian__
268268
Regular linear XYZ.
269269

270270
```javascript
@@ -277,7 +277,7 @@ Regular linear XYZ.
277277
})
278278
```
279279

280-
__Projective__
280+
__Projective__
281281
Applies a 4x4 homogeneous/projective transform.
282282

283283
```javascript
@@ -294,7 +294,7 @@ Applies a 4x4 homogeneous/projective transform.
294294
})
295295
```
296296

297-
__Polar__
297+
__Polar__
298298
Polar coordinate grid in radians. X is angle, Y is radius, Z is ordinary depth.
299299
Also useful for visualizing complex operations in polar representation.
300300

@@ -312,7 +312,7 @@ Also useful for visualizing complex operations in polar representation.
312312
})
313313
```
314314

315-
__Sphere__
315+
__Sphere__
316316
Spherical coordinate grid in radians. X is longitude, Y is latitude, Z is radius.
317317

318318
```javascript
@@ -456,6 +456,22 @@ Vector
456456
})
457457
```
458458

459+
Tests
460+
-----
461+
462+
1. You can run them using the web-server:
463+
464+
`npm start`
465+
466+
then go to `localhost:8000/test/test.html`
467+
468+
2. or if you're feeling lazy :
469+
470+
`npm test`
471+
472+
(You will need to have phantomjs installed, please run `npm install` first)
473+
474+
459475
Contributions
460476
-------------
461477

0 commit comments

Comments
 (0)