jquery

jQuery JavaScript Library

Find a file

John Resig 4e7d565e50 Added two more tweaks for XHTML core tests.		2009-01-19 23:33:46 +00:00
build	core: ant build - add Date and Revision to to header (just like make build)	2009-01-18 13:30:09 +00:00
src	Brought the logic for handling isXMLDoc over from Sizzle.	2009-01-19 23:17:30 +00:00
test	Added two more tweaks for XHTML core tests.	2009-01-19 23:33:46 +00:00
build.xml	core: ant build - add Date and Revision to to header (just like make build)	2009-01-18 13:30:09 +00:00
ChangeLog.txt	Updating changlog	2007-12-17 01:11:02 +00:00
GPL-LICENSE.txt	Updated the licensing information.	2006-08-21 19:36:44 +00:00
Makefile	core: removed outdated docs target from makefile	2009-01-14 22:42:21 +00:00
MIT-LICENSE.txt	Updated License Year, fixes #3871 .	2009-01-17 22:25:18 +00:00
README	Updated the README to be more explanatory.	2006-08-16 21:20:38 +00:00
reminder.txt	general: adding reminder.txt to write down things to remember for future releases.	2008-07-09 19:26:41 +00:00
version.txt	core: removed newline from version.txt, easier to use it via Ant then	2009-01-14 22:42:55 +00:00

README

--------------------------------
jQuery - New Wave Javascript
http://jquery.com/
--------------------------------

What you need to build your own jQuery:
 - Make sure that you have Java installed.

   If not, go to this page and download "Java Runtime Environment (JRE) 5.0"
   http://java.sun.com/javase/downloads/index.jsp

 - 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.

 - 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

   If you do have Ant, everytime (in this README) that I say 'make', do
   'ant' instead - it works identically (for all intents and purposes).

How to build your own jQuery:

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

Here are each of the individual items that are buildable from the Makefile.

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

make lite
  jQuery without all the additional inline documentation and test cases.
  Makes: ./dist/jquery.lite.js

make pack
  A compressed version of jQuery (made with Packer).
  Makes: ./dist/jquery.pack.js

make docs
  Builds a complete copy of the documentation, based upon the jQuery source.
  Makes ./docs/
  Open this file in your browser:
    ./docs/index.xml

make test
  Builds a complete copy of the test suite, based upon the jQuery source.
  Makes ./test/
  Open this file in your browser:
    ./test/index.html

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

Additionally, if you want to install jQuery to a location that is not this
directory, you can specify the PREFIX directory, for example:
  make PREFIX=/home/john/test/
OR
  make PREFIX=~/www/ docs

If you have any questions, please feel free to ask them on the jQuery
mailing list, which can be found here:
  http://jquery.com/discuss/