Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added License and README

  • Loading branch information...
commit 17e21593c9e7b7d16272a200377f14767509430d 1 parent aa17831
@davglass authored
Showing with 60 additions and 0 deletions.
  1. +25 −0 LICENSE
  2. +35 −0 README.md
View
25 LICENSE
@@ -0,0 +1,25 @@
+Copyright 2012 Yahoo! Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+ * Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+ * Neither the name of the Yahoo! Inc. nor the
+ names of its contributors may be used to endorse or promote products
+ derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL YAHOO! INC. BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
View
35 README.md
@@ -0,0 +1,35 @@
+Shifter - Blazingly Fast YUI Builder
+====================================
+
+The purpose of this project is to replace YUI's use of our old ant [https://github.com/yui/builder](Builder).
+
+We have out grown our old builder, so it was time to build a new one!
+
+Usage
+-----
+
+Shifter will parse your current `*.properties` files and convert them into a `build.json` file that
+it can process. It only imports the relevant settings required to build the module.
+
+**It does not import module meta-data**
+
+Instead, Shifter parses the meta-data from the modules `meta/*.json` files and uses that instead.
+So you don't have to declare your meta-data in more than one place now.
+
+Migrating
+---------
+
+Shifter is designed to work side by side with our current builder (for now) so you don't have to
+switch over to using it fully if it doesn't work properly for you. Just don't delete your `*.properties`
+files until you are sure that Shifter builds your module properly. If it doesn't, file a ticket and
+we'll get it fixed up ASAP.
+
+Shifter will read a `build.json` file if it exists, if one doesn't and it finds a `*.properties` file
+it will generate the `build.json` from them. So if you have issues with the build, just delete the `build.json`
+file and have Shifter regenerate it after your issue is fixed.
+
+
+GearJS
+------
+
+Shifter is built using [http://gearjs.org/](GearJS)
Please sign in to comment.
Something went wrong with that request. Please try again.