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 Build Options
  11 --------------
  12
  13 You now have **three** options for building jQuery:
  14
  15 * **`make`**: If you have access to common UNIX commands (like `make`, `mkdir`, `rm`, `cat`, and `echo`) then simply type `make` to build all the components.
  16
  17 * **`rake`**: If you have Ruby Rake installed, you can simply type `rake` to build all the components. This method works on both Windows and UNIX/Linux systems.
  18
  19 * **`ant`**: 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).
  20
  21 How to build your own jQuery
  22 -----------------------------
  23
  24 *Note: If you are using either `rake` or `ant`, substitute your chosen method in place of `make` in the examples below. They work identically for all intents and purposes. Quick reference is also available for `rake` by typing `rake -T` in the `jquery` directory.*
  25
  26 In the main directory of the distribution (the one that this file is in), type
  27 the following to make all versions of jQuery:
  28
  29     make
  30
  31 *Here are each of the individual items that are buildable from the Makefile:*
  32
  33     make init
  34
  35 Pull in all the external dependencies (QUnit, Sizzle) for the project.
  36
  37     make jquery
  38
  39 The standard, uncompressed, jQuery code.
  40 Makes: `./dist/jquery.js`
  41
  42     make min
  43
  44 A compressed version of jQuery (made the Closure Compiler).
  45 Makes: `./dist/jquery.min.js`
  46
  47     make lint
  48
  49 Tests a build of jQuery against JSLint, looking for potential errors or bits of confusing code.
  50
  51     make selector
  52
  53 Builds the selector library for jQuery from Sizzle.
  54 Makes: `./src/selector.js`
  55
  56 Finally, you can remove all the built files using the command:
  57
  58     make clean
  59
  60 Building to a different directory
  61 ----------------------------------
  62
  63 If you want to install jQuery to a location that is not this directory, you can...
  64
  65 **Make only:** Specify the PREFIX directory, for example:
  66
  67     make PREFIX=/home/john/test/ [command]
  68
  69 With this example, the output files would be contained in `/home/john/test/dist/`
  70
  71 **Rake only:** Define the DIST_DIR directory, for example:
  72
  73     rake DIST_DIR=/home/john/test/ [command]
  74
  75 With this example, the output files would be contained in `/home/john/test/`
  76
  77 *In both examples, `[command]` is optional.*
  78
  79 **Ant only:** You cannot currently build to another directory when using Ant.
  80
  81 Questions?
  82 ----------
  83
  84 If you have any questions, please feel free to ask them on the jQuery
  85 mailing list, which can be found here:
  86 [http://docs.jquery.com/Discussion](http://docs.jquery.com/Discussion)