README for Archistry Core JavaScript Library

Last updated: Sun 11 Sep 2011 15:08:55 IST

Getting Started - Command Line

The Archistry JS library is designed to work with both the native browser JavaScript engines as well as the Rhino engine from the command line.

To build the installation packages, you also need to have the Ruby language installed so that you can run the 'jspkg' command in the tools directory.

Rhino JavaScript Engine

To use the library from the command line, you need to have the Mozilla Rhino JavaScript engine available. Installation on MacOS X is easy from MacPorts:

$ sudo port install rhino

On other operating systems, the installation may be more complex.

Building the Library

"Building" the library simply means packaging and optionally minimizing the library source into a single, installable JavaScript file.

To build the unimimized package, execute the following command:

$ jspkg

To build a minimized version of the package, add the '-m' parameter:

$ jspkg -m

Running the Tests

The test cases for the library are written for the Archistry Jester test framework. Jester is loosely based on Ara T. Howard's Testy test framework for Ruby, and will print results using the YAML format with the command-line runner.

Running Tests with Rhino

To run the tests, ensure that the deliverables have been built and execute the following commands (examples assume UNIX-like shell):

$ cd test
$ rhino rhino.js