jQuery JavaScript Library

Find a file

scottjehl 610ab137da Merge branch 'master' of https://github.com/jquery/jquery		2011-01-13 14:14:04 -05:00
build	Handle the case where JSLint complains about arguments in try/catch already being defined (we use the name 'e' consistently for catch(e) - will work to standardize on that now).	2010-10-17 10:50:17 -04:00
speed	Adding some rooted-find perf tests.	2010-10-10 16:06:33 -04:00
src	Merge branch 'master' of https://github.com/jquery/jquery	2011-01-13 14:14:04 -05:00
test	Fixes #4964 . Adds a statusCode object together with a new statusCode method on the jXHR object (deferred behaviour). They accept a map of statusCode/callback(s). Callbacks are fired when the status code of the response correponds to the key (as a success or an error callback depending on how the request completed). Unit tests added.	2011-01-13 17:01:25 +01:00
.gitattributes	Mark *.jar files as binary.	2010-11-12 07:41:44 +02:00
.gitignore	Adding .DS_Store to Git ignore.	2009-12-09 23:49:13 -08:00
build.xml	Renamed src/transports to src/ajax (in case we need prefilters in the future and to avoid a separate prefilters directory).	2011-01-06 01:17:31 +01:00
GPL-LICENSE.txt	Updated the licensing information.	2006-08-21 19:36:44 +00:00
Makefile	Renamed src/transports to src/ajax (in case we need prefilters in the future and to avoid a separate prefilters directory).	2011-01-06 01:17:31 +01:00
MIT-LICENSE.txt	Updating year to 2011.	2011-01-04 06:52:26 -08:00
Rakefile	Renamed src/transports to src/ajax (in case we need prefilters in the future and to avoid a separate prefilters directory).	2011-01-06 01:17:31 +01:00
README.md	Updated the Questions? section with the forum information.	2010-09-17 12:40:04 -07:00
version.txt	Updating the source version to 1.4.5pre.	2010-11-11 19:05:10 -05:00

README.md

jQuery - New Wave Javascript

What you need to build your own jQuery

Make sure that you have Java installed (if you want to build a minified version of jQuery).
If not, go to this page and download "Java Runtime Environment (JRE) 5.0"

Build Options

You now have three options for building jQuery:

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.
rake: If you have Ruby Rake installed (on either Windows or UNIX/Linux), you can simply type rake to build all the components.
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].

How to build your own jQuery

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.

In the main directory of the distribution (the one that this file is in), type the following to make all versions of jQuery:

make

Here are the individual items that are buildable from the Makefile:

make init

Pull in all the external dependencies (QUnit, Sizzle) for the project.

make jquery

The standard, uncompressed, jQuery code.
Makes: ./dist/jquery.js

make min

A compressed version of jQuery (made the Closure Compiler).
Makes: ./dist/jquery.min.js

make lint

Tests a build of jQuery against JSLint, looking for potential errors or bits of confusing code.

make selector

Builds the selector library for jQuery from Sizzle.
Makes: ./src/selector.js

Finally, you can remove all the built files using the command:

make clean

Building to a different directory

If you want to build jQuery to a directory that is different from the default location, you can...

Make only: Specify the PREFIX directory, for example:

make PREFIX=/home/john/test/ [command]

With this example, the output files would be contained in /home/john/test/dist/

Rake only: Define the DIST_DIR directory, for example:

rake DIST_DIR=/home/john/test/ [command]

With this example, the output files would be contained in /home/john/test/

In both examples, [command] is optional.

Ant only: You cannot currently build to another directory when using Ant.

Questions?

If you have any questions, please feel free to ask them on the Developing jQuery Core forum, which can be found here:
http://forum.jquery.com/developing-jquery-core