Skip to content

Commit 1dfecf4

Browse files
author
James Cryer
committed
Updated README
1 parent e496d9b commit 1dfecf4

1 file changed

Lines changed: 18 additions & 10 deletions

File tree

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,9 @@ From the command line/terminal run:
3333

3434
* `casperjs test demo/testsuite.js`
3535

36-
Some useful CasperJS CLI options:
37-
* `casperjs test --verbose --log-level=debug demo/testsuite.js`
38-
* `casperjs test demo/testsuite.js --engine=slimerjs`
39-
* `casperjs test demo/testsuite.js --engine=phantomjs`
36+
or
37+
38+
* `casperjs test demo/testsuite.js --verbose --log-level=debug`
4039

4140
### Download
4241

@@ -55,15 +54,26 @@ Some useful CasperJS CLI options:
5554
* In the failures folder some images should have been created. The images should show bright pink where the screenshot has visually changed
5655
* If you want to manually compare the images, go to the screenshot folder to see the original/baseline and latest screenshots
5756

57+
### SlimerJS
58+
59+
SlimerJS uses the Gecko browser engine rather than Webkit. It currently has better support for Webfonts and can load Flash content if the plugin is installed. If this is of interest to you, please follow the [download and install](http://slimerjs.org/download.html) instructions and ensure SlimerJS is installed globally.
60+
61+
* `casperjs test demo/testsuite.js --engine=slimerjs`
62+
63+
### PhantomJS 2
64+
65+
The latest and greatest version of PhantomJS is not currently supported, as soon as CasperJS has confirmed full support we can look to update PhantomCSS. If (in the future) support has become viable, and you're eager to upgrade, please create and Issue and/or Pull Request.
66+
5867
### Options and setup
5968

69+
If you are using SlimerJS, you will need to specify absolute paths (see 'demo').
70+
6071
```javascript
6172
phantomcss.init({
6273
/*
6374
libraryRoot is relative to this file and must point to your
6475
phantomcss folder (not lib or node_modules). If you are using
65-
NPM, this will be './node_modules/phantomcss'. If you are using
66-
SlimerJS, you will need absolute paths (see 'demo').
76+
NPM, this will be './node_modules/phantomcss'.
6777
*/
6878
libraryRoot: './modules/PhantomCSS',
6979

@@ -73,15 +83,13 @@ phantomcss.init({
7383
By default, failure images are put in the './failures' folder.
7484
If failedComparisonsRoot is set to false a separate folder will
7585
not be created but failure images can still be found alongside
76-
the original and new images. If you are using
77-
SlimerJS, you will need absolute paths (see 'demo').
86+
the original and new images.
7887
*/
7988
failedComparisonsRoot: './failures',
8089

8190
/*
8291
Remove results directory tree after run. Use in conjunction
83-
with failedComparisonsRoot to see failed comparisons. If you are using
84-
SlimerJS, you will need absolute paths (see 'demo').
92+
with failedComparisonsRoot to see failed comparisons.
8593
*/
8694
cleanupComparisonImages: true,
8795

0 commit comments

Comments
 (0)