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