Skip to content

Commit c95e09e

Browse files
janiceilenephated
authored andcommitted
Docs: Improve "Getting Started" (#1985)
1 parent 5df0865 commit c95e09e

File tree

1 file changed

+29
-7
lines changed

1 file changed

+29
-7
lines changed

docs/getting-started.md

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,27 @@
11
# Getting Started
22

3-
*If you've previously installed gulp globally, run `npm rm --global gulp` before following these instructions.*
3+
*If you've previously installed gulp globally, run `npm rm --global gulp` before following these instructions.* For more information, read this [Sip](https://medium.com/gulpjs/gulp-sips-command-line-interface-e53411d4467).
4+
5+
#### Check for Node and npm
6+
Make sure that you've installed Node and npm before attempting to install gulp.
7+
8+
```sh
9+
node --version
10+
```
11+
```sh
12+
npm --version
13+
```
414

515
#### Install the `gulp` command
616

717
```sh
818
npm install --global gulp-cli
919
```
1020

21+
#### Create a `package.json`
22+
If you don't have a package.json, create one. If you need help, run an `npm init` which will walk you through giving it a name, version, description, etc.
23+
24+
1125
#### Install `gulp` in your devDependencies
1226

1327
Run this command in your project directory:
@@ -18,7 +32,7 @@ npm install --save-dev gulp
1832

1933
#### Create a `gulpfile`
2034

21-
Create a file called `gulpfile.js` in your project root with these contents:
35+
In your project directory, create a file named `gulpfile.js` in your project root with these contents:
2236

2337
```js
2438
var gulp = require('gulp');
@@ -36,13 +50,21 @@ Run the gulp command in your project directory:
3650
gulp
3751
```
3852

53+
To run multiple tasks, you can use `gulp <task> <othertask>`.
54+
55+
#### Result
56+
3957
Voila! The default task will run and do nothing.
4058

41-
To run multiple tasks, you can use `gulp <task> <othertask>`.
59+
```sh
60+
Using gulpfile ~/my-project/gulpfile.js
61+
[11:15:51] Starting 'default'...
62+
[11:15:51] Finished 'default' after 103 μs
63+
```
4264

4365
## Where do I go now?
4466

45-
- [API Documentation](API.md)
46-
- [Recipes](recipes)
47-
- [Help Articles](README.md#articles)
48-
- [Plugins](http://gulpjs.com/plugins/)
67+
- [API Documentation](API.md) - The programming interface, defined
68+
- [Recipes](recipes) - Specific examples from the community
69+
- [In Depth Help](https://travismaynard.com/writing/getting-started-with-gulp) - A tutorial from the the guy who wrote the book
70+
- [Plugins](http://gulpjs.com/plugins/) - Building blocks for your gulp file

0 commit comments

Comments
 (0)