X-Git-Url: http://git.asbjorn.biz/?a=blobdiff_plain;f=README;h=80b1b49fe67f0ff6c4cc9267e72b9419808d6c49;hb=81f65ce33931831dc651c5d3ebf2b31b551b6b8b;hp=ae65e4b2130ca03b2f0f20be64d64df6c5dc3855;hpb=f8402b9a081f0096986d140f809f4d57c6db7834;p=jquery.git diff --git a/README b/README index ae65e4b..80b1b49 100644 --- a/README +++ b/README @@ -4,39 +4,45 @@ jQuery - New Wave Javascript http://jquery.com/ -------------------------------- +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" + 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: - - Make sure that you have Java installed. - - And some common UNIX commands (like 'make', 'mkdir', 'rm', 'cat', and 'echo') 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: +the following to make all versions of jQuery: make Here are each of 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 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 min + A compressed version of jQuery (made the YUI Minifier). + Makes: ./dist/jquery.min.js -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 +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 @@ -49,4 +55,4 @@ OR 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/ + http://docs.jquery.com/Discussion