You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 10, 2019. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,13 +13,11 @@ The Gulp Edition comes with the following components:
13
13
14
14
## Prerequisites
15
15
16
-
Pattern Lab Node uses [Node](https://nodejs.org)and [npm](https://www.npmjs.com/) to manage project dependencies, and [gulp](http://gulpjs.com/) to run tasks and interface with core.
16
+
The Pattern Lab Node - Gulp Edition uses [Node](https://nodejs.org)for core processing, [npm](https://www.npmjs.com/) to manage project dependencies, and [gulp.js](http://gulpjs.com/) to run tasks and interface with the core library. Node version 4 or higher suffices. You can follow the directions for [installing Node](https://nodejs.org/en/download/) on the Node website if you haven't done so already. Installation of Node will include npm.
17
17
18
-
Please follow the directions for [installing Node](https://nodejs.org/en/download/) on the Node website. This should include `npm`.
18
+
It's also highly recommended that you [install gulp](hhttps://github.com/gulpjs/gulp/blob/4.0/docs/getting-started.md) globally.
19
19
20
-
It's also highly recommended that you [install gulp](https://github.com/gulpjs/gulp/blob/master/docs/getting-started.md) globally.
21
-
22
-
* Note: The Gulp Edition uses Gulp 4, which may require a new global install of the CLI tool Gulp uses. Follow the [gulp upgrade instructions](https://github.com/pattern-lab/edition-node-gulp/wiki/Updating-to-Gulp-4) if you already have gulp installed and need to upgrade.
20
+
> Note: The Gulp Edition of Pattern Lab uses Gulp 4, which may require a new global install of the Gulp command line interface. Follow the [gulp upgrade instructions](https://github.com/pattern-lab/edition-node-gulp/wiki/Updating-to-Gulp-4) if you already have gulp installed and need to upgrade. Gulp 4 is in alpha, but brings many benefits to the table and is relatively stable.
23
21
24
22
## Installing
25
23
@@ -30,19 +28,22 @@ There are two methods for downloading and installing the Gulp Edition:
30
28
31
29
### Download a pre-built package
32
30
33
-
The fastest way to get started with the Gulp Edition is to [download the pre-built version](https://github.com/pattern-lab/edition-node-gulp/releases) from the [releases page](https://github.com/pattern-lab/edition-node-gulp/releases). The pre-built project comes with the [Default Starterkit for Mustache](https://github.com/pattern-lab/starterkit-mustache-default/tree/dev) installed by default.
31
+
The fastest way to get started with the Gulp Edition is to [download the pre-built version](https://github.com/pattern-lab/edition-node-gulp/releases) from the [releases page](https://github.com/pattern-lab/edition-node-gulp/releases). The pre-built project comes with the [Demo Starterkit for Mustache](https://github.com/pattern-lab/starterkit-mustache-demo) installed by default.
34
32
35
33
**Please note:** Pattern Lab Node uses [npm](https://www.npmjs.com/) to manage project dependencies. To upgrade the Gulp Edition or to install plug-ins you'll need to be familiar with npm.
36
34
37
35
### Use npm
38
36
39
37
`npm` is a dependency management and package system which can pull in all of the Gulp Edition's dependencies for you. To accomplish this:
40
38
41
-
* download or clone this repository to an install location.
39
+
* download or `git clone` this repository to an install location.
42
40
43
41
* run the following
42
+
43
+
```
44
44
cd install/location
45
45
npm install
46
+
```
46
47
47
48
Running `npm install` from a directory containing a `package.json` file will download all dependencies defined within.
0 commit comments