jquery/README.md

86 lines
2.8 KiB
Markdown
Raw Normal View History

[jQuery](http://jquery.com/) - New Wave Javascript
2009-11-02 22:36:49 +01:00
================================
What you need to build your own jQuery
---------------------------------------
2010-06-14 17:25:22 +02:00
* Make sure that you have Java installed (if you want to build a minified version of jQuery).
If not, [go to this page](http://java.sun.com/javase/downloads/index.jsp) and download "Java Runtime Environment (JRE) 5.0"
2009-11-02 22:36:49 +01:00
Build Options
--------------
2009-11-02 22:36:49 +01:00
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.
2010-06-14 17:49:30 +02:00
* **`rake`**: If you have Ruby Rake installed (on either Windows or UNIX/Linux), you can simply type `rake` to build all the components.
2010-06-14 17:25:22 +02:00
* **`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].
2009-11-02 22:36:49 +01:00
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.*
2009-11-02 22:36:49 +01:00
In the main directory of the distribution (the one that this file is in), type
the following to make all versions of jQuery:
make
2009-11-02 22:36:49 +01:00
2010-06-14 17:49:30 +02:00
*Here are the individual items that are buildable from the Makefile:*
2009-11-02 22:36:49 +01:00
make init
2009-11-02 22:36:49 +01:00
Pull in all the external dependencies (QUnit, Sizzle) for the project.
make jquery
2009-11-02 22:36:49 +01:00
2009-11-02 22:40:00 +01:00
The standard, uncompressed, jQuery code.
Makes: `./dist/jquery.js`
2009-11-02 22:36:49 +01:00
make min
2009-11-02 22:36:49 +01:00
A compressed version of jQuery (made the Closure Compiler).
Makes: `./dist/jquery.min.js`
2009-11-02 22:36:49 +01:00
make lint
Tests a build of jQuery against JSLint, looking for potential errors or bits of confusing code.
make selector
2009-11-02 22:36:49 +01:00
2009-11-02 22:40:00 +01:00
Builds the selector library for jQuery from Sizzle.
Makes: `./src/selector.js`
2009-11-02 22:36:49 +01:00
Finally, you can remove all the built files using the command:
make clean
Building to a different directory
----------------------------------
2010-06-14 17:49:30 +02:00
If you want to build jQuery to a directory that is different from the default location, you can...
2009-11-02 22:36:49 +01:00
**Make only:** Specify the PREFIX directory, for example:
2009-11-02 22:36:49 +01:00
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?
----------
2009-11-02 22:36:49 +01:00
If you have any questions, please feel free to ask them on the jQuery
2009-11-02 22:40:00 +01:00
mailing list, which can be found here:
[http://docs.jquery.com/Discussion](http://docs.jquery.com/Discussion)