Browse files

Update the README with new build commands and a few grammar fixes

  • Loading branch information...
1 parent e300a09 commit 54e3c1942c27a0015c4eff845eae321449f0091c @davidkaneda davidkaneda committed Feb 17, 2013
Showing with 39 additions and 19 deletions.
  1. +39 −19
@@ -1,6 +1,8 @@
+[![Build Status](](
Create powerful mobile apps with just HTML, CSS, and Zepto.js (or jQuery).
@@ -19,8 +21,8 @@ jQTouch is a JavaScript plugin which works with either Zepto.js or jQuery, and c
## Upcoming Features
*Note: Upcoming features are developed in the master branch, and are not to be considered stable. For official releases, please see the [version tags](*
-- [Zepto]( integration - Use with Zepto.js instead of jQuery to cut down on precious bandwidth. Zepto.js is very similar API to jQuery, but optimized for WebKit and thus about 20kb smaller.
-- Sass-based stylesheets, easily modified with variables, and optimized for size.
+- [Zepto]( integration - Use Zepto.js instead of jQuery to cut down on precious bandwidth. Zepto.js features a similar API to jQuery, but optimized for WebKit and much smaller.
+- Sass-based stylesheets, easily modified with variables and optimized for size.
- Image-less stylesheets -- Using [Compass Recipes](, we have recreated all of the gradients and background patterns with CSS. This way, they are resolution independent, dynamically theme-able, and lower bandwidth.
See, [New and Noteworthy]( for Details.
@@ -29,23 +31,41 @@ See, [New and Noteworthy](
[Watch this video preview]( to see it in action.
-## Building / Contribute
-[![Build Status](](
+## Building your own version of jQTouch
+### Dependencies
+We have quite a few dependencies at the moment, as we build certain features directly from Zepto (which uses Rake), and we use Compass for stylesheets, which is only available via Ruby. The actual build system, however, is built on Grunt.
+Please make sure you have the following installed:
+* [Ruby]( — Comes default on Macs, Windows users can use [RubyInstaller](
+* [Sass]( & [Compass]( — Install both with `sudo gem install compass` once you have Ruby/RubyGems installed
+* [Node.js & NPM]( — `brew install node`
+* [Grunt CLI]( — Install with `npm install -g grunt-cli` once you have Node.js as listed above.
+* Local node packages — Run `npm install` from this directory
+### Commands
+#### `grunt` (default)
+Will create a build of jQTouch in the `build/` directory, compiling any theme files and updating with source from the Zepto submodule. This must be run to preview jQTouch.
+#### `grunt watch`
+Will create the same build as above, but will continue to watch for file changes to theme and source files, compiling/copying them into build every time you save. If you have a livereload browser extension installed and enabled, the page will update live after every change.
+#### `grunt compass`
+Only build the theme files. Typically, you'll want to use `grunt watch` for developing a custom theme.
+#### `grunt test`
+Run our test suite.
+#### `grunt dist`
- <tr><th>target</th><th>description</th><th>dependencies</th></tr>
- <tr><td>`grunt --help`</td><td>List available build targets.</td><td>nodejs, grunt: ex, `brew install node && npm install grunt -g && npm install`</td></tr>
- <tr><td>`grunt css`</td><td>Build SASS resources into css.</td><td>`ruby`, `compass` + `grunt --help` dependencies: ex, `gem install compass`</td></tr>
- <tr><td>`grunt test`</td><td>Run all unit tests.</td><td>`phantomjs` + `grunt --help` dependencies: ex, `brew install phantomjs`</td></tr>
- <tr><td>`grunt dist`</td><td>Build a distribution.</td><td>`grunt css` + `grunt test` dependencies</td></tr>
-The command `grunt dist` builds a folder structure under `jqtouch-${release.version}-${}`.
+This is typically used internally for creating releases — It does everything the standard build does, but then additionally minifies all JS/CSS and updates the paths in demo files.
External Guides
@@ -63,7 +83,7 @@ Maintained by [Thomas Yip](
Special thanks to [pinch/zoom]( and [Jonathan Stark](
-(c) 2009-2012 Sencha Labs.
+(c) 2009-2013 Sencha Labs.
jQTouch may be freely distributed under the MIT license.
See LICENSE.txt for license.

0 comments on commit 54e3c19

Please sign in to comment.