Skip to content

Commit

Permalink
Docs: Improve "Getting Started" (#1985)
Browse files Browse the repository at this point in the history
  • Loading branch information
janiceilene authored and phated committed Jul 19, 2017
1 parent 5df0865 commit c95e09e
Showing 1 changed file with 29 additions and 7 deletions.
36 changes: 29 additions & 7 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,27 @@
# Getting Started

*If you've previously installed gulp globally, run `npm rm --global gulp` before following these instructions.*
*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).

#### Check for Node and npm
Make sure that you've installed Node and npm before attempting to install gulp.

```sh
node --version
```
```sh
npm --version
```

#### Install the `gulp` command

```sh
npm install --global gulp-cli
```

#### Create a `package.json`
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.


#### Install `gulp` in your devDependencies

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

#### Create a `gulpfile`

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

```js
var gulp = require('gulp');
Expand All @@ -36,13 +50,21 @@ Run the gulp command in your project directory:
gulp
```

To run multiple tasks, you can use `gulp <task> <othertask>`.

#### Result

Voila! The default task will run and do nothing.

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

## Where do I go now?

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

0 comments on commit c95e09e

Please sign in to comment.