Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update README to include grunt-cli step.

  • Loading branch information...
commit b0e40a4fd3253eb5472f127533a38aa69709d23e 1 parent f717226
@dmethvin dmethvin authored
Showing with 12 additions and 11 deletions.
  1. +12 −11 README.md
View
23 README.md
@@ -45,12 +45,17 @@ First, clone a copy of the main jQuery git repo by running:
git clone git://github.com/jquery/jquery.git
```
-Enter the directory and install the Node dependencies:
+Install the grunt-cli package so that you will have the correct version of grunt available from any project that needs it. This should be done as a global install:
```bash
-cd jquery && npm install
+npm install -g grunt-cli
```
+Enter the jquery directory and install the Node dependencies, this time *without* specifying a global install:
+
+```bash
+cd jquery && npm install
+```
Make sure you have `grunt` installed by testing:
@@ -58,16 +63,13 @@ Make sure you have `grunt` installed by testing:
grunt -version
```
-
-
Then, to get a complete, minified (w/ Uglify.js), linted (w/ JSHint) version of jQuery, type the following:
```bash
grunt
```
-
-The built version of jQuery will be put in the `dist/` subdirectory.
+The built version of jQuery will be put in the `dist/` subdirectory, along with the minified copy and associated map file.
### Modules (new in 1.8)
@@ -165,7 +167,7 @@ Run the unit tests with a local server that supports PHP. No database is require
Building to a different directory
---------------------------------
-If you want to build jQuery to a directory that is different from the default location:
+To copy the built jQuery files from `/dist` to another directory:
```bash
grunt && grunt dist:/path/to/special/location/
@@ -177,7 +179,7 @@ With this example, the output files would be:
/path/to/special/location/jquery.min.js
```
-If you want to add a permanent copy destination, create a file in `dist/` called ".destination.json". Inside the file, paste and customize the following:
+To add a permanent copy destination, create a file in `dist/` called ".destination.json". Inside the file, paste and customize the following:
```json
@@ -186,7 +188,6 @@ If you want to add a permanent copy destination, create a file in `dist/` called
}
```
-
Additionally, both methods can be combined.
@@ -204,8 +205,8 @@ Note: This task will also be run any time the default `grunt` command is used.
-Git for dummies
----------------
+Essential Git
+-------------
As the source code is handled by the version control system Git, it's useful to know some features used.
Please sign in to comment.
Something went wrong with that request. Please try again.