Skip to content

Commit 405bfe3

Browse files
bradfrostbmuenzenmeyer
authored andcommitted
Update installation instructions
1 parent 3581f4f commit 405bfe3

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

packages/docs/src/docs/installation.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,27 @@ tags:
55
category: getting-started
66
---
77

8-
<strong>The PHP version of Pattern Lab is being deprecated in favor of a new unified Pattern Lab core. <a href='./php/installation'>The PHP docs for this topic can be viewed here.</a></strong>
8+
Once you have the requisite [requirements installed](/docs/requirements), install Pattern Lab by running the following command in your terminal:
9+
10+
```
11+
npm create pattern-lab
12+
```
13+
14+
This will bring up an installation menu that presents the following steps:
15+
16+
- `Please specify a directory for your Pattern Lab project.` - Choose the directory where you want to install Pattern Lab. The default location is the current directory.
17+
- `Which edition do you want to use (defaults to edition-node)?` - Choose the Pattern Lab edition that you want to install. The options are:
18+
- `edition-node (handlebars engine)`
19+
- `edition-twig (php engine)`
20+
- `edition-node-gulp (legacy)`
21+
- `Which starterkit do you want to use?` - Choose the <a href="/docs/advanced-starterkits.html">Starterkit</a> you want to begin your project with. Starterkits define the initial components and assets that are included in the initial project. Start from scratch, start from a full demo, or a lightweight boilerplate.
22+
- `Are you happy with your choices? (Hit enter for YES)?` - Confirm your choices, and when done the Pattern Lab installation will begin.
23+
24+
With those questions answered, Pattern Lab will begin installing. Once the installation is complete, you're ready to <a href="/docs/generating-pattern-lab.html">generate Pattern Lab for the first time.</a>
25+
26+
---
27+
28+
Legacy versions of Pattern Lab Node 2.X are also available:
29+
30+
- <a class="link-desc-list__link" href="https://github.com/pattern-lab/edition-node-gulp/releases/tag/v1.3.4">Gulp Edition</a> - The Gulp wrapper around <a href="https://github.com/pattern-lab/patternlab-node/tree/master/packages/core">Pattern Lab Node Core</a>
31+
- <a class="link-desc-list__link" href="https://github.com/Comcast/patternlab-edition-node-webpack">Webpack Edition</a> - The Webpack wrapper around <a href="https://github.com/pattern-lab/patternlab-node/tree/master/packages/core">Pattern Lab Node Core</a> Thanks to the team at Comcast for <a href="https://comcast.github.io">open-sourcing</a> this stellar work!

0 commit comments

Comments
 (0)