Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
garris committed Nov 1, 2017
1 parent 4f6db12 commit c236476
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -511,11 +511,11 @@ See casperjs documentation for more info on instance options. An example config
```

### Setting Chromy option flags
Chromy enables a lot of behavior via constructor options. See Chromy documentation for more info.
Chromy enables a lot of behavior via constructor options. See Chromy documentation for more info.

**NOTE:** Backstop sets defaults for many Chromy properties. Setting a parameter value with engineOptions will override any default value set by backstop. _But please watch out for the following..._
- (TLDR) Setting `port` is _very_ _very_ not advised.
- Setting `chromeFlags` will override all chromeFlags properties set by backstop -- **EXCEPT FOR `--window-size`***... (i.e. `--window-size` flag will be added by backstop if not found in chromeFlags)
- Setting `chromeFlags` will override all chromeFlags properties set by backstop -- **EXCEPT FOR `--window-size`***... (i.e. `--window-size` flag will be added by backstop if not found in chromeFlags)
- Setting `--window-size` explicitly in `chromeFlags` will override values used in your viewport settings.


Expand Down Expand Up @@ -732,12 +732,18 @@ For all engines there is also the `debug` setting. This enables verbose console
```


### The dreaded: `Error: Failed to launch a browser.`
### `Error: Failed to launch a browser.`
Sometimes (usually after an app error) a chrome process is left open. If that's the case try...
```
pkill -f "(chrome)?(--headless)"
```

### `Chromy error: Error. See scenario ...`
Same as the above issue. If a zombie Chrome instance is blocking a port, you can run...
```
pkill -f "(chrome)?(--headless)"
```

### The dreaded: _command-not-found_ error...

Did you install BackstopJS with the global option? If installing globally remember to add that `-g` when installing with npm *i.e.* `npm install backstop -g`. If you installed *locally*, remember that the `backstop <command>` pattern will only be available to your npm scripts -- see the local installation section above for more info.
Expand Down

0 comments on commit c236476

Please sign in to comment.