| 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. |
|---|
| 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, the documentation, and the test suite: |
|---|
| 28 | make |
|---|
| 29 | |
|---|
| 30 | Here are each of the individual items that are buildable from the Makefile. |
|---|
| 31 | |
|---|
| 32 | make jquery |
|---|
| 33 | The standard, uncompressed, jQuery code. |
|---|
| 34 | Makes: ./dist/jquery.js |
|---|
| 35 | |
|---|
| 36 | make lite |
|---|
| 37 | jQuery without all the additional inline documentation and test cases. |
|---|
| 38 | Makes: ./dist/jquery.lite.js |
|---|
| 39 | |
|---|
| 40 | make pack |
|---|
| 41 | A compressed version of jQuery (made with Packer). |
|---|
| 42 | Makes: ./dist/jquery.pack.js |
|---|
| 43 | |
|---|
| 44 | make docs |
|---|
| 45 | Builds a complete copy of the documentation, based upon the jQuery source. |
|---|
| 46 | Makes ./docs/ |
|---|
| 47 | Open this file in your browser: |
|---|
| 48 | ./docs/index.xml |
|---|
| 49 | |
|---|
| 50 | make test |
|---|
| 51 | Builds a complete copy of the test suite, based upon the jQuery source. |
|---|
| 52 | Makes ./test/ |
|---|
| 53 | Open this file in your browser: |
|---|
| 54 | ./test/index.html |
|---|
| 55 | |
|---|
| 56 | Finally, you can remove all the built files using the command: |
|---|
| 57 | make clean |
|---|
| 58 | |
|---|
| 59 | Additionally, if you want to install jQuery to a location that is not this |
|---|
| 60 | directory, you can specify the PREFIX directory, for example: |
|---|
| 61 | make PREFIX=/home/john/test/ |
|---|
| 62 | OR |
|---|
| 63 | make PREFIX=~/www/ docs |
|---|
| 64 | |
|---|
| 65 | If you have any questions, please feel free to ask them on the jQuery |
|---|
| 66 | mailing list, which can be found here: |
|---|
| 67 | http://jquery.com/discuss/ |
|---|
