README.md

Waffle

Travis build status

Library Main Page

Absolute|0|

COS 301 Main project

We are a determined team, always aiming to do our Absolute|0| best..

Team members

Name	Profile Page
Idrian van der Westhuizen	LinkedIn
Chris Dreyer	LinkedIn
HD Haasbroek	LinkedIn
Pearce Jackson	LinkedIn
Cameron Trivella	LinkedIn

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

A web browser supporting WebGL

- Google Chrome
- Mozilla Firefox
- Midori
- Safari
- Opera
- Internet Explorer
- Microsoft Edge
- Vivaldi

Usage

Download latest minified javascript

voxc.min.js

voxc.min.js will display its output in any div with the id of "voxelDemo"

<div id="voxelDemo"></div>

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

- voxc.js is built with TypeScript and THREE.js
- voxc.js is tested with Travis and Jasmine
- voxc.js is minified and built with Webpack 3

License

This project is open source

MIT License