Skip to content

Commit ed4f8dd

Browse files
committed
- ADD: Added a note in the README during installation to run with elevated privileges
- THX: Thanks @RichardBray for the heads up - ADD: Added a Prerequisites section to the README
1 parent 3dfe791 commit ed4f8dd

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

CHANGELOG

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@ THIS CHANGELOG IS AN ATTEMPT TO DOCUMENT CHANGES TO THIS PROJECT.
33
PL-node-v0.15.2
44
- FIX: Resolve issue with not hiding underscored patterns.
55
- THX: Thanks @ivancamilov for reporting this regression.
6+
- FIX: Fix misapplied error input class
7+
- THX: Thanks @johngerome for the pull request!
8+
- ADD: Added a note in the README during installation to run with elevated privileges
9+
- THX: Thanks @RichardBray for the heads up
10+
- ADD: Added a Prerequisites section to the README
611

712
PL-node-v0.15.1
813
- FIX: Resolve issue with styleModifiers not being replaced when the partial has spaces in it.

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,20 @@ The Node version of [Pattern Lab](http://patternlab.io/) is, at its core, a stat
66

77
This repository contains the vanilla builder logic, grunt and gulp configurations, and some sample template/css/data to illustrate the power and flexibility of the tool.
88

9+
### Prerequisites
10+
11+
Make sure Node and npm are installed. A great guide can be found here: [https://docs.npmjs.com/getting-started/installing-node](https://docs.npmjs.com/getting-started/installing-node)
12+
913
### Download
1014

1115
* Download the [latest release of patternlab-node](https://github.com/pattern-lab/patternlab-node/releases/latest) from Github
1216
* Via npm, run `npm install patternlab-node` (Note this will auto install the grunt version currently. see below)
1317
* **NOTE** Node version 4.X and 5.X have tentative support, citing [a lot of Windows issues](https://github.com/nodejs/node-gyp/issues/629), including [mine](https://github.com/pattern-lab/patternlab-node/issues/162). Upgrade node at your own risk until otherwise stated. I've tried to catalog some issues and troubleshooting steps on the [wiki](https://github.com/pattern-lab/patternlab-node/wiki/Windows-Issues).
1418

19+
### Troubleshooting Installs
20+
21+
Make sure you are running your terminal/command line session as administrator. This could mean `sudo`, or opening the window with a right-click option.
22+
1523
### Choose Your Adventure! Now Vanilla, Grunt & Gulp
1624

1725
This repository ships with two `package.json` files, a `Gruntfile.js`, and a `gulpfile.js`. The default is grunt currently. The core builder is not dependent on either.

0 commit comments

Comments
 (0)