Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added OS support section #210

Merged
merged 3 commits into from
Oct 11, 2017
Merged

Added OS support section #210

merged 3 commits into from
Oct 11, 2017

Conversation

carloskelly13
Copy link

@carloskelly13 carloskelly13 commented Oct 11, 2017

  • Refactored OS and Terminal support documentation with additional key combinations for specific features
  • Add Linux documentation

Addresses #209

README.md Outdated
**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. The main log can be scrolled using the <kbd>↑</kbd>, <kbd>↓</kbd>, <kbd>Page Up</kbd>, and <kbd>Page Down</kbd> keys.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you link in the blessed section discussing limitations on Window? Maybe:

Mouse events are not supported at this time, as discussed further in the documentation of the underlying terminal library we use, blessed.

Copy link
Member

@ryan-roemer ryan-roemer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work!

@carloskelly13 carloskelly13 merged commit 3f558c3 into master Oct 11, 2017
@carloskelly13 carloskelly13 deleted the doc-updates branch October 11, 2017 19:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants