Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 1.67 KB

README.md

File metadata and controls

61 lines (41 loc) · 1.67 KB

AwayJS

Build Status

AwayJS is a graphics library for javascript written in typescript.

Features

TODO

Examples

Installation

Flat Installation

AwayJS can be installed as a flattened package using awayjs-full or awayjs-lite via npm.

npm install --save @awayjs/awayjs-full		 

or

npm install --save @awayjs/awayjs-lite		

Modular Installation

AwayJS can be installed as a series of interdependant modules (see below) that can be configured, depending on the specific requirements of the application. This configuration should provide the best experience for typed development using typescript.

First, clone awayjs-full, then run the script InitAwayDev_mac.command TODO links neededs or InitAwayDev_win.bat. The script will clone all the dependencies, and interlink them in the awayjs-full installation.

In your application, install awayjs-full via npm:

npm install --save @awayjs/awayjs-full		

You can then link your awayjs-full package to your local configuration:

npm link path/to/your/@awayjs/folder		

Documentation

Official AwayJS Documentation