README.md

   1 [jQuery](http://jquery.com/) - New Wave Javascript
   2 ==================================================
   3
   4 What you need to build your own jQuery
   5 --------------------------------------
   6
   7 In order to build jQuery, you need to have GNU make 3.8 or later, Node.js 0.2 or later, and git 1.7 or later.
   8 (Earlier versions might work OK, but are not tested.)
   9
  10 Windows users have two options:
  11
  12 1. Install [msysgit](https://code.google.com/p/msysgit/) (Full installer for official Git),
  13    [GNU make for Windows](http://gnuwin32.sourceforge.net/packages/make.htm), and a
  14    [binary version of Node.js](http://node-js.prcn.co.cc/). Make sure all three packages are installed to the same
  15    location (by default, this is C:\Program Files\Git).
  16 2. Install [Cygwin](http://cygwin.com/) (make sure you install the git, make, and which packages), then either follow
  17    the [Node.js build instructions](https://github.com/ry/node/wiki/Building-node.js-on-Cygwin-%28Windows%29) or install
  18    the [binary version of Node.js](http://node-js.prcn.co.cc/).
  19
  20 Mac OS users should install Xcode (comes on your Mac OS install DVD, or downloadable from
  21 [Apple's Xcode site](http://developer.apple.com/technologies/xcode.html)) and
  22 [http://mxcl.github.com/homebrew/](Homebrew). Once Homebrew is installed, run `brew install git` to install git,
  23 and `brew install node` to install Node.js.
  24
  25 Linux/BSD users should use their appropriate package managers to install make, git, and node, or build from source
  26 if you swing that way. Easy-peasy.
  27
  28
  29 How to build your own jQuery
  30 ----------------------------
  31
  32 First, clone a copy of the main jQuery git repo by running `git clone git://github.com/jquery/jquery.git`.
  33
  34 Then, to get a complete, minified, jslinted version of jQuery, simply `cd` to the `jquery` directory and type
  35 `make`. If you don't have Node installed and/or want to make a basic, uncompressed, unlinted version of jQuery, use
  36 `make jquery` instead of `make`.
  37
  38 The built version of jQuery will be put in the `dist/` subdirectory.
  39
  40 To remove all built files, run `make clean`.
  41
  42
  43 Building to a different directory
  44 ---------------------------------
  45
  46 If you want to build jQuery to a directory that is different from the default location, you can specify the PREFIX
  47 directory: `make PREFIX=/home/jquery/test/ [command]`
  48
  49 With this example, the output files would end up in `/home/jquery/test/dist/`.
  50
  51
  52 Troubleshooting
  53 ---------------
  54
  55 Sometimes, the various git repositories get into an inconsistent state where builds don't complete properly
  56 (usually this results in the jquery.js or jquery.min.js being 0 bytes). If this happens, run `make clean`, then
  57 run `make` again.
  58
  59
  60 Questions?
  61 ----------
  62
  63 If you have any questions, please feel free to ask on the
  64 [Developing jQuery Core forum](http://forum.jquery.com/developing-jquery-core) or in #jquery on irc.freenode.net.