From 776006b503d239a0d7809494bf9b3b2474df5518 Mon Sep 17 00:00:00 2001 From: Patrick Filler Date: Sun, 31 Jul 2011 14:05:56 -0400 Subject: [PATCH] Upated readme file with build info. --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9857199..1f404a8 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,35 @@ Chosen is a library for making long, unwieldy select boxes more user friendly. - jQuery support: 1.4+ - Prototype support: 1.7+ -For documentation, usage, and examples, see: +For documentation, usage, and examples, see: http://harvesthq.github.com/chosen +### Contributing to Chosen + +Contributions and pull requests are very welcome. Please follow these guidelines when submitting new code. + +1. Make all changes in Coffeescript files, **not** JavaScript files. +2. For feature changes, update both jQuery *and* Prototype versions +3. Use 'cake build' to generate Chosen's JavaScript file and minified version. +4. Update VERSION file according to [Semantic Versioning](http://semver.org/) guidelines. +5. Submit a Pull Request using GitHub. + +### Using CoffeeScript & Cake + +First, make sure you have the proper CoffeeScript / Cake set-up in place. + +1. Install Coffeescript: the [CoffeeScript documentation](http://jashkenas.github.com/coffee-script/) provides easy-to-follow instructions. +2. Install UglifyJS: npm -g install uglify-js +3. Verify that your $NODE_PATH is properly configured using echo $NODE_PATH + +Once you're configured, building the JavasScript from the command line is easy: + + cake build # build Chosen from source + cake watch # watch coffee/ for changes and build Chosen + +If you're interested, you can find the recipes in Cakefile. + + ### Chosen Credits - Built by [Harvest](http://www.getharvest.com/)