Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 36 lines (23 sloc) 1.365 kb
17e2159 @davglass Added License and README
davglass authored
1 Shifter - Blazingly Fast YUI Builder
2 ====================================
3
463b160 @davglass Update README
davglass authored
4 The purpose of this project is to replace YUI's use of our old ant [Builder](https://github.com/yui/builder).
17e2159 @davglass Added License and README
davglass authored
5
6 We have out grown our old builder, so it was time to build a new one!
7
8 Usage
9 -----
10
11 Shifter will parse your current `*.properties` files and convert them into a `build.json` file that
12 it can process. It only imports the relevant settings required to build the module.
13
14 **It does not import module meta-data**
15
16 Instead, Shifter parses the meta-data from the modules `meta/*.json` files and uses that instead.
17 So you don't have to declare your meta-data in more than one place now.
18
19 Migrating
20 ---------
21
22 Shifter is designed to work side by side with our current builder (for now) so you don't have to
23 switch over to using it fully if it doesn't work properly for you. Just don't delete your `*.properties`
24 files until you are sure that Shifter builds your module properly. If it doesn't, file a ticket and
25 we'll get it fixed up ASAP.
26
27 Shifter will read a `build.json` file if it exists, if one doesn't and it finds a `*.properties` file
28 it will generate the `build.json` from them. So if you have issues with the build, just delete the `build.json`
29 file and have Shifter regenerate it after your issue is fixed.
30
31
32 GearJS
33 ------
34
463b160 @davglass Update README
davglass authored
35 Shifter is built using [GearJS](http://gearjs.org/)
Something went wrong with that request. Please try again.