Skip to content

Commit b0e40a4

Browse files
committed
Update README to include grunt-cli step.
1 parent f717226 commit b0e40a4

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -45,29 +45,31 @@ First, clone a copy of the main jQuery git repo by running:
4545
git clone git://github.com/jquery/jquery.git
4646
```
4747

48-
Enter the directory and install the Node dependencies:
48+
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:
4949

5050
```bash
51-
cd jquery && npm install
51+
npm install -g grunt-cli
5252
```
5353

54+
Enter the jquery directory and install the Node dependencies, this time *without* specifying a global install:
55+
56+
```bash
57+
cd jquery && npm install
58+
```
5459

5560
Make sure you have `grunt` installed by testing:
5661

5762
```bash
5863
grunt -version
5964
```
6065

61-
62-
6366
Then, to get a complete, minified (w/ Uglify.js), linted (w/ JSHint) version of jQuery, type the following:
6467

6568
```bash
6669
grunt
6770
```
6871

69-
70-
The built version of jQuery will be put in the `dist/` subdirectory.
72+
The built version of jQuery will be put in the `dist/` subdirectory, along with the minified copy and associated map file.
7173

7274

7375
### Modules (new in 1.8)
@@ -165,7 +167,7 @@ Run the unit tests with a local server that supports PHP. No database is require
165167
Building to a different directory
166168
---------------------------------
167169

168-
If you want to build jQuery to a directory that is different from the default location:
170+
To copy the built jQuery files from `/dist` to another directory:
169171

170172
```bash
171173
grunt && grunt dist:/path/to/special/location/
@@ -177,7 +179,7 @@ With this example, the output files would be:
177179
/path/to/special/location/jquery.min.js
178180
```
179181

180-
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:
182+
To add a permanent copy destination, create a file in `dist/` called ".destination.json". Inside the file, paste and customize the following:
181183

182184
```json
183185

@@ -186,7 +188,6 @@ If you want to add a permanent copy destination, create a file in `dist/` called
186188
}
187189
```
188190

189-
190191
Additionally, both methods can be combined.
191192

192193

@@ -204,8 +205,8 @@ Note: This task will also be run any time the default `grunt` command is used.
204205

205206

206207

207-
Git for dummies
208-
---------------
208+
Essential Git
209+
-------------
209210

210211
As the source code is handled by the version control system Git, it's useful to know some features used.
211212

0 commit comments

Comments
 (0)