README.md

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