README.markdown

   1 jQuery - New Wave Javascript
   2 http://jquery.com/
   3 ================================
   4
   5 What you need to build your own jQuery
   6 ---------------------------------------
   7 * Make sure that you have Java installed (if you want to build a minified version of jQuery).
   8 If not, go to this page and download "Java Runtime Environment (JRE) 5.0"
   9 [http://java.sun.com/javase/downloads/index.jsp](http://java.sun.com/javase/downloads/index.jsp)
  10
  11 * You now have two options for building jQuery, if you have access to common UNIX commands (like `make`, `mkdir`, `rm`, `cat`, and `echo`) then simply type `make` to build all the components.
  12
  13 * The other option is if you have Ant installed (or are on Windows and don't have access to make). You can download Ant from here: [http://ant.apache.org/bindownload.cgi](http://ant.apache.org/bindownload.cgi)
  14 If you do have Ant, everytime (in this README) that I say 'make', do 'ant' instead - it works identically (for all intents and purposes).
  15
  16 How to build your own jQuery
  17 -----------------------------
  18
  19 In the main directory of the distribution (the one that this file is in), type
  20 the following to make all versions of jQuery:
  21
  22 `make`
  23
  24 Here are each of the individual items that are buildable from the Makefile.
  25
  26 `make init`
  27
  28 Pull in all the external dependencies (QUnit, Sizzle) for the project.
  29
  30 `make jquery`
  31
  32 The standard, uncompressed, jQuery code.
  33 Makes: ./dist/jquery.js
  34
  35 `make min`
  36
  37 A compressed version of jQuery (made the YUI Minifier).
  38 Makes: ./dist/jquery.min.js
  39
  40 `make selector`
  41
  42 Builds the selector library for jQuery from Sizzle.
  43 Makes: ./src/selector.js
  44
  45 Finally, you can remove all the built files using the command:
  46
  47 `make clean`
  48
  49 Additionally, if you want to install jQuery to a location that is not this
  50 directory, you can specify the PREFIX directory, for example:
  51
  52 `make PREFIX=/home/john/test/`
  53
  54 OR
  55
  56 `make PREFIX=~/www/ docs`
  57
  58 If you have any questions, please feel free to ask them on the jQuery
  59 mailing list, which can be found here:
  60 [http://docs.jquery.com/Discussion](http://docs.jquery.com/Discussion)