Skip to content

Commit

Permalink
Added OS support section (#210)
Browse files Browse the repository at this point in the history
* Added OS support section

* Added Linux docs.

* Fix typo.
  • Loading branch information
Carlos Paelinck authored Oct 11, 2017
1 parent c9be427 commit 3f558c3
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ That's cool, but it's mostly noise and scrolly and not super helpful. This plugi

### Use

***OS X Terminal.app users:*** Make sure that **View → Allow Mouse Reporting** is enabled, otherwise scrolling through logs and modules won't work. If your version of Terminal.app doesn't have this feature, you may want to check out an alternative such as [iTerm2](https://www.iterm2.com/index.html).

First, import the plugin and add it to your webpack config, or apply it to your compiler:

```js
Expand Down Expand Up @@ -69,6 +67,16 @@ Finally, start your server using whatever command you have set up. Either you ha

Then, sit back and pretend you're an astronaut.


### Supported Operating Systems and Terminals
**macOS →**
Webpack Dashboard works in Terminal, iTerm 2, and Hyper. For mouse events, like scrolling, in Terminal you will need to ensure *View → Enable Mouse Reporting* is enabled. This is supported in macOS El Capitan, Sierra, and High Sierra. In iTerm 2, to select full rows of text hold the <kbd>⌥ Opt</kbd> key. To select a block of text hold the <kbd>⌥ Opt</kbd> + <kbd>⌘ Cmd</kbd> key combination.

**Windows 10 →** Webpack Dashboard works in Command Prompt, PowerShell, and Linux Subsystem for Windows. Mouse events are not supported at this time, as discussed further in the documentation of the underlying terminal library we use [Blessed](https://github.com/chjj/blessed#windows-compatibility). The main log can be scrolled using the <kbd>↑</kbd>, <kbd>↓</kbd>, <kbd>Page Up</kbd>, and <kbd>Page Down</kbd> keys.

**Linux →** Webpack Dashboard has been verified in the built-in terminal app for Debian-based Linux distributions such as Ubuntu or Mint. Mouse events and scrolling are supported automatically. To highlight or select lines hold the <kbd>⇧ Shift</kbd> key.


### API

#### webpack-dashboard (CLI)
Expand Down

0 comments on commit 3f558c3

Please sign in to comment.