jquery/README.md

65 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
--------------------------------------
2009-11-02 22:36:49 +01:00
In order to build jQuery, you need to have GNU make 3.8 or later, Node.js 0.2 or later, and git 1.7 or later.
(Earlier versions might work OK, but are not tested.)
2009-11-02 22:36:49 +01:00
Windows users have two options:
1. Install [msysgit](https://code.google.com/p/msysgit/) (Full installer for official Git),
[GNU make for Windows](http://gnuwin32.sourceforge.net/packages/make.htm), and a
[binary version of Node.js](http://node-js.prcn.co.cc/). Make sure all three packages are installed to the same
location (by default, this is C:\Program Files\Git).
2. Install [Cygwin](http://cygwin.com/) (make sure you install the git, make, and which packages), then either follow
the [Node.js build instructions](https://github.com/ry/node/wiki/Building-node.js-on-Cygwin-%28Windows%29) or install
the [binary version of Node.js](http://node-js.prcn.co.cc/).
Mac OS users should install Xcode (comes on your Mac OS install DVD, or downloadable from
[Apple's Xcode site](http://developer.apple.com/technologies/xcode.html)) and
[http://mxcl.github.com/homebrew/](Homebrew). Once Homebrew is installed, run `brew install git` to install git,
and `brew install node` to install Node.js.
Linux/BSD users should use their appropriate package managers to install make, git, and node, or build from source
if you swing that way. Easy-peasy.
2009-11-02 22:36:49 +01:00
How to build your own jQuery
----------------------------
2009-11-02 22:36:49 +01:00
First, clone a copy of the main jQuery git repo by running `git clone git://github.com/jquery/jquery.git`.
Then, to get a complete, minified, jslinted version of jQuery, simply `cd` to the `jquery` directory and type
`make`. If you don't have Node installed and/or want to make a basic, uncompressed, unlinted version of jQuery, use
`make jquery` instead of `make`.
The built version of jQuery will be put in the `dist/` subdirectory.
2009-11-02 22:36:49 +01:00
To remove all built files, run `make clean`.
2009-11-02 22:36:49 +01:00
Building to a different directory
---------------------------------
If you want to build jQuery to a directory that is different from the default location, you can specify the PREFIX
directory: `make PREFIX=/home/jquery/test/ [command]`
2009-11-02 22:36:49 +01:00
With this example, the output files would end up in `/home/jquery/test/dist/`.
Troubleshooting
---------------
Sometimes, the various git repositories get into an inconsistent state where builds don't complete properly
(usually this results in the jquery.js or jquery.min.js being 0 bytes). If this happens, run `make clean`, then
run `make` again.
Questions?
----------
2009-11-02 22:36:49 +01:00
If you have any questions, please feel free to ask on the
[Developing jQuery Core forum](http://forum.jquery.com/developing-jquery-core) or in #jquery on irc.freenode.net.