Installation¶

Whirl is designed to be capable of running offline and in the browser.

You first need to compile the library from the source and then include it in your project.

1. Clone the repository.

git clone https://github.com/MatthewWid/Whirl.git

2. Navigate to the root directory.

cd "Whirl"

3. Install dependencies.

npm install

4. Build the source.

npm run prod

You should now see that a file called whirl.js has appeared in the /build/ directory.

Usage¶

Once you have a copy of the compiled source you can include it into your project:

<script src="whirl.js"></script>

or

const Whirl = require("whirl.js");

Alternatively, you can simply open the index.html file in any of the example projects in the /examples/ directory to quickly mess around with and observe what the engine is capable of.