Skip to content

Commit 1d435bf

Browse files
AmitMYmanucorporat
authored andcommitted
docs(snapshot): missing vital info (ionic-team#11502)
* docs(snapshot): depends on java jdk as well * docs(snapshot): only works on a retina mac * docs(snapshot): move explanation out of setup * docs(snapshot): only for mac
1 parent 5d56216 commit 1d435bf

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

scripts/README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,11 +86,15 @@ To remove the linked version of `ionic-angular` do `npm rm ionic-angular`, and t
8686

8787
### Running Snapshot
8888

89-
#### Setup
89+
Snapshot compares to a base snapshot made on Mac OS with retina screen (2560x1600).
90+
It does not work for windows, linux, or non retina macs.
9091

91-
1. Install [Protractor](https://angular.github.io/protractor/#/): `npm install -g protractor@2.5.1`
92-
2. Run `webdriver-manager update`
93-
3. Export `IONIC_SNAPSHOT_KEY` (get from someone)
92+
#### Setup (Mac OS X Only)
93+
94+
1. Install Java JDK: `brew cask install java`
95+
2. Install [Protractor](https://angular.github.io/protractor/#/): `npm install -g protractor@2.5.1`
96+
3. Run `webdriver-manager update`
97+
4. Export `IONIC_SNAPSHOT_KEY` (get from someone)
9498

9599
#### Commands
96100

0 commit comments

Comments
 (0)