README.md

   1 MooTools Core Specs
   2 ===================
   3
   4 This repository is intended to provide the specification infrastructure for MooTools Core.
   5
   6 The infrastructure uses Jasmine as a UnitTest-Library. It is possible to run Specs via
   7 the browser, via JSTestDriver and via NodeJS.
   8
   9 ### Setup
  10
  11 Clone the MooTools Core repository and initialize the submodules.
  12
  13 Set up the Specs:
  14
  15         cd Specs
  16         git pull origin master
  17         git submodule update --init --recursive
  18         cd Runner
  19         chmod +x server test runner runner.js buildCommonJS buildJSTDConfiguration
  20
  21 ### Requirements
  22
  23 * NodeJS
  24 * PHP (for Packager)
  25
  26 ### Usage
  27
  28 * Open index.html in your favorite browser and press the right link
  29 * Run the JSTD Server
  30         * Start via ./server {options}
  31         * Point one or more browsers to http://localhost:9876
  32         * Run all tests via ./test
  33 * Run in NodeJS via ./runner {options}
  34
  35 ### Available Options
  36
  37 Options are specified via JSON.
  38
  39 Example for JSTD
  40         ./server '{"version": 1.3, "path": "../core/", "specs": [1.2, "1.3base", "1.3client"]}'
  41
  42 Example for NodeJS
  43         ./runner '{"specs": ["1.3base"], "path": "../core/"}'
  44
  45 Options
  46         "path" - Only needs to be specified if the core-specs repository is being used outside of the MooTools Core repository
  47         "specs" - The specs to run, see Sets.js
  48         "version" - The version of MooTools to be used for running the specs