building.txt

                             %--------------%
                          ////   YABS.JS   \\\\
                          #>>----------------<<#

                            BUILD INSTRUCTIONS
  
                          #>>----------------<<#
                          \\\\             ////
                             %--------------%



PREREQUISITES
-------------

To start with, you will need node.js. Download and install from https://nodejs.org/.

To use YABS.js in any meaningful capacity, you will need the uglify-js package.
Install via command line using:

  npm -g install uglify-js

To build some of the examples that use the preprocessor, you will also need the
MetaScript package. Install using:

  npm -g install metascript

You should now be able to build from the command line.

All commands listed below should be run from the project root folder.



I. BUILD EVERYTHING AT ONCE
---------------------------

If you just want to build everything and be done with it, use:

  node build

This will:
  - build yabs.js and output build.js
  - build all examples and output them into build/examples/.
  - build all tests and output them into build/tests/.

 

II. BUILD YABS.JS
-----------------

To build YABS.js, use:

  node yabs build.json

This will build yabs.js and output build.js.



III. BUILD ALL EXAMPLES
-----------------------

To build all examples, use:

  node build examples

This will build all examples and output them into build/examples/.



IV. BUILD ALL TESTS
-------------------

To build all tests, use:

  node build tests

This will build all tests and output them into build/tests/.



V. BUILD A SPECIFIC TEST OR EXAMPLE
-----------------------------------

To build a specific example, use:

  node build examples/<example_name>

For example:

  node build examples/minimal

This will build the "minimal" example and output it into build/examples/minimal.

Similarly, to build a specific test, use:

  node build test/<test_name>