README.md

   1 # MooTools Core
   2
   3 [![Build Status](https://travis-ci.org/mootools/mootools-core.png?branch=master)](https://travis-ci.org/mootools/mootools-core)
   4
   5 This repository is for MooTools developers; not users.
   6 All users should download MooTools from [MooTools.net](http://mootools.net/download "Download MooTools")
   7
   8 ## Building & Testing
   9
  10 Current build process uses [Grunt](http://github.com/gruntjs), [Grunt MooTools Packager plugin](https://github.com/ibolmo/grunt-packager), and [Karma related repos](http://github.com/karma-runner/grunt-karma).
  11
  12 **By default**, the build process runs the tests (specs) relevant to the build. To build without testing see the `packager` build targets.
  13
  14 ### Building MooTools _With_ Compatibility
  15 This means `1.4.6` that is compatible with: `1.3.x`, `1.2.x`, and so on.
  16
  17 **Examples**
  18
  19         grunt               # or
  20         grunt packager:all  # to only build the source
  21
  22 ### Building MooTools _Without_ Compatibility
  23 This means `1.4.6` **without** deprecated code in `1.3.x`, `1.2.x`, and so on.
  24
  25 ``` js
  26 'Proceed at your own risk'
  27 See the changelog or the blog related to each version for migrating your code.
  28 ```
  29
  30 **Examples**
  31
  32         grunt nocompat           # or
  33         grunt packager:nocompat  # to only build the source
  34
  35 ### Advanced Building and Testing
  36 See the [Gruntfile](https://github.com/ibolmo/mootools-core/blob/1.4.6/Gruntfile.js) for further options.
  37
  38 **Examples**
  39
  40         # with compat
  41         grunt --file=Function    # builds all deps on Core/Function, builds all Specs on Specs/Core/Function, runs karma
  42         grunt --module=Class     # builds all deps on Class *folder*, builds all Specs on Specs/Class *folder*
  43
  44         # without compat
  45         grunt nocompat --file=Function    # builds all deps on Core/Function, builds all Specs on Specs/Core/Function, runs karma
  46         grunt nocompat --module=Class     # builds all deps on Class *folder*, builds all Specs on Specs/Class *folder*
  47
  48 #### Removing Other Packager Blocks
  49 You'll need to add a specific task to the Gruntfile. See [line 24](https://github.com/ibolmo/mootools-core/blob/1.4.6/Gruntfile.js#L24) for an example.
  50
  51 #### Browsers, Platforms, and More
  52 This is a todo. We'll support SauceLabs soon™ and browsers will be added in a specific build target soon™.
  53
  54 ## More Information
  55
  56 [See the MooTools Wiki for more information](http://github.com/mootools/mootools-core/wikis)