README

   1
   2 --------------------------------
   3 jQuery - New Wave Javascript
   4 http://jquery.com/
   5 --------------------------------
   6
   7 How to build your own jQuery:
   8  - Make sure that you have Java installed.
   9  - And some common UNIX commands (like 'make', 'mkdir', 'rm', 'cat', and 'echo')
  10
  11 In the main directory of the distribution (the one that this file is in), type
  12 the following to make all versions of jQuery, the documentation, and the test suite:
  13   make
  14
  15 Here are each of the individual items that are buildable from the Makefile.
  16
  17 make jquery
  18   The standard, uncompressed, jQuery code.
  19   Makes: ./dist/jquery.js
  20
  21 make lite
  22   jQuery without all the additional inline documentation and test cases.
  23   Makes: ./dist/jquery.lite.js
  24
  25 make pack
  26   A compressed version of jQuery (made with Packer).
  27   Makes: ./dist/jquery.pack.js
  28
  29 make docs
  30   Builds a complete copy of the documentation, based upon the jQuery source.
  31   Makes ./docs/
  32   Open this file in your browser:
  33     ./docs/index.xml
  34
  35 make test
  36   Builds a complete copy of the test suite, based upon the jQuery source.
  37   Makes ./test/
  38   Open this file in your browser:
  39     ./test/index.html
  40
  41 Finally, you can remove all the built files using the command:
  42   make clean
  43
  44 Additionally, if you want to install jQuery to a location that is not this
  45 directory, you can specify the PREFIX directory, for example:
  46   make PREFIX=/home/john/test/
  47 OR
  48   make PREFIX=~/www/ docs
  49
  50 If you have any questions, please feel free to ask them on the jQuery
  51 mailing list, which can be found here:
  52   http://jquery.com/discuss/