From: John Resig <jeresig@gmail.com>
Date: Mon, 14 Aug 2006 02:00:28 +0000 (+0000)
Subject: Added a README file to help explain the new build process.
X-Git-Url: http://git.asbjorn.it/?a=commitdiff_plain;h=f8402b9a081f0096986d140f809f4d57c6db7834;p=jquery.git

Added a README file to help explain the new build process.
---

diff --git a/README b/README
new file mode 100644
index 0000000..ae65e4b
--- /dev/null
+++ b/README
@@ -0,0 +1,52 @@
+
+--------------------------------
+jQuery - New Wave Javascript
+http://jquery.com/
+--------------------------------
+
+How to build your own jQuery:
+ - Make sure that you have Java installed.
+ - And some common UNIX commands (like 'make', 'mkdir', 'rm', 'cat', and 'echo')
+
+In the main directory of the distribution (the one that this file is in), type
+the following to make all versions of jQuery, the documentation, and the test suite:
+  make
+
+Here are each of the individual items that are buildable from the Makefile.
+
+make jquery
+  The standard, uncompressed, jQuery code.
+  Makes: ./dist/jquery.js
+
+make lite
+  jQuery without all the additional inline documentation and test cases.
+  Makes: ./dist/jquery.lite.js
+
+make pack
+  A compressed version of jQuery (made with Packer).
+  Makes: ./dist/jquery.pack.js
+
+make docs
+  Builds a complete copy of the documentation, based upon the jQuery source.
+  Makes ./docs/
+  Open this file in your browser:
+    ./docs/index.xml
+
+make test
+  Builds a complete copy of the test suite, based upon the jQuery source.
+  Makes ./test/
+  Open this file in your browser:
+    ./test/index.html
+
+Finally, you can remove all the built files using the command:
+  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:
+  make PREFIX=/home/john/test/
+OR
+  make PREFIX=~/www/ docs
+
+If you have any questions, please feel free to ask them on the jQuery
+mailing list, which can be found here:
+  http://jquery.com/discuss/