Skip to content

Added a note about windows compatibility to the readme #41

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.

Sign up for GitHub

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

Merged
WyriHaximus merged 3 commits into from
Jul 13, 2017
+9 −0
Merged

Added a note about windows compatibility to the readme #41

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6496697
Added a note about windows compatibility to the readme
WyriHaximus Jul 8, 2017
97884a6
Added link to windows note in the table of contents
WyriHaximus Jul 8, 2017
2d3e2eb
Windows is with a capital W
WyriHaximus Jul 10, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ as [Streams](https://github.com/reactphp/stream).
* [Stream Properties](#stream-properties)
* [Command](#command)
* [Sigchild Compatibility](#sigchild-compatibility)
* [Windows Compatibility](#windows-compatibility)
* [Install](#install)
* [Tests](#tests)
* [License](#license)
Expand Down Expand Up @@ -219,6 +220,14 @@ of the actual exit code.
**Note:** This functionality was taken from Symfony's
[Process](https://github.com/symfony/process) compoment.

### Windows Compatibility

Due to the blocking nature of `STDIN`/`STDOUT`/`STDERR` pipes on windows we cannot
Copy link
Copy Markdown

@kelunik kelunik Jul 8, 2017

Choose a reason for hiding this comment

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

Uhm, shouldn't that be does not work on Windows? IIRC stream does error out if it can't set the stream to non-blocking.

guarantee this package works as expected on directly windows. However this package
does work on [`Windows Subsystem for Linux`](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux)
(or WSL) without issues. We suggest [installing WSL](https://msdn.microsoft.com/en-us/commandline/wsl/install_guide)
when you want to run this package on windows.

## Install

The recommended way to install this library is [through Composer](http://getcomposer.org).
Expand Down