X-Git-Url: http://git.asbjorn.biz/?p=jquery.git;a=blobdiff_plain;f=README.md;h=384e2d19096da830189c9549161d8a9871e9257c;hp=6e32fdfe00b091f99b2588c4e3207c7e2cbeea96;hb=f28c774f2cde004a33aefc28306d995c599d963b;hpb=c97e914d40a8a24b47f2b6ef4f706b5367d94ee2 diff --git a/README.md b/README.md index 6e32fdf..384e2d1 100644 --- a/README.md +++ b/README.md @@ -3,57 +3,83 @@ 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](http://java.sun.com/javase/downloads/index.jsp) +* 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" -* 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. +Build Options +-------------- -* 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](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). +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. + +* **`rake`**: If you have Ruby Rake installed (on either Windows or UNIX/Linux), you can simply type `rake` to build all the components. + +* **`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]. 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.* + In the main directory of the distribution (the one that this file is in), type the following to make all versions of jQuery: -`make` + make -Here are each of the individual items that are buildable from the Makefile. +*Here are the individual items that are buildable from the Makefile:* -`make init` + make init Pull in all the external dependencies (QUnit, Sizzle) for the project. -`make jquery` + make jquery The standard, uncompressed, jQuery code. -Makes: ./dist/jquery.js +Makes: `./dist/jquery.js` -`make min` + make min A compressed version of jQuery (made the Closure Compiler). -Makes: ./dist/jquery.min.js +Makes: `./dist/jquery.min.js` + + make lint + +Tests a build of jQuery against JSLint, looking for potential errors or bits of confusing code. -`make selector` + make selector Builds the selector library for jQuery from Sizzle. -Makes: ./src/selector.js +Makes: `./src/selector.js` Finally, you can remove all the built files using the command: -`make clean` + make clean -Additionally, if you want to install jQuery to a location that is not this -directory, you can specify the PREFIX directory, for example: +Building to a different directory +---------------------------------- + +If you want to build jQuery to a directory that is different from the default location, you can... + +**Make only:** Specify the PREFIX directory, for example: -`make PREFIX=/home/john/test/` + 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.* -OR +**Ant only:** You cannot currently build to another directory when using Ant. -`make PREFIX=~/www/ docs` +Questions? +---------- -If you have any questions, please feel free to ask them on the jQuery -mailing list, which can be found here: -[http://docs.jquery.com/Discussion](http://docs.jquery.com/Discussion) +If you have any questions, please feel free to ask them on the Developing jQuery Core +forum, which can be found here: +[http://forum.jquery.com/developing-jquery-core](http://forum.jquery.com/developing-jquery-core)