Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updated README file with updated information for the Rake addtions

Also changed the default Rake task to "all" instead of "jquery"
to parallel the Makefile.
  • Loading branch information...
commit 4e337f504e623646f36785b25222b7f7392fbd46 1 parent ab2537a
@dcneiner dcneiner authored wycats committed
Showing with 45 additions and 18 deletions.
  1. +44 −17 README.md
  2. +1 −1  Rakefile
View
61 README.md
@@ -7,52 +7,79 @@ What you need to build your own 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)
-* 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, you can simply type `rake` to build all the components. This method works on both Windows and UNIX/Linux systems.
+
+* **`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](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 each of 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`
+ 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
+
+Building to a different directory
+----------------------------------
+
+If you want to install jQuery to a location that is not this directory, you can...
-Additionally, if you want to install jQuery to a location that is not this
-directory, you can specify the PREFIX directory, for example:
+**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.*
+
+**Ant only:** You cannot currently build to another directory when using Ant.
+
+Questions?
+----------
If you have any questions, please feel free to ask them on the jQuery
mailing list, which can be found here:
View
2  Rakefile
@@ -34,7 +34,7 @@ minfier = "java -jar #{build_dir}/google-compiler-20091218.jar"
verbose(false)
# Tasks
-task :default => "jquery"
+task :default => "all"
desc "Builds jQuery; Tests with JSLint; Minifies jQuery"
task :all => [:jquery, :lint, :min] do
Please sign in to comment.
Something went wrong with that request. Please try again.