From 649669798ce9dfb1e179b705baac1a8b83718cca Mon Sep 17 00:00:00 2001 From: Cees-Jan Kiewiet Date: Sat, 8 Jul 2017 23:43:05 +0200 Subject: [PATCH 1/3] Added a note about windows compatibility to the readme --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 2da5993..2bfa037 100644 --- a/README.md +++ b/README.md @@ -219,6 +219,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 +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). From 97884a6e0e18ac5fefb520d8934300c71b487bbc Mon Sep 17 00:00:00 2001 From: Cees-Jan Kiewiet Date: Sat, 8 Jul 2017 23:45:46 +0200 Subject: [PATCH 2/3] Added link to windows note in the table of contents --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 2bfa037..c784ae9 100644 --- a/README.md +++ b/README.md @@ -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) From 2d3e2eb7bddaf4b3bfa9c3eace9230f8e6502f87 Mon Sep 17 00:00:00 2001 From: Cees-Jan Kiewiet Date: Mon, 10 Jul 2017 18:12:42 +0200 Subject: [PATCH 3/3] Windows is with a capital W --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c784ae9..2fb4e9f 100644 --- a/README.md +++ b/README.md @@ -222,11 +222,11 @@ of the actual exit code. ### Windows Compatibility -Due to the blocking nature of `STDIN`/`STDOUT`/`STDERR` pipes on windows we cannot -guarantee this package works as expected on directly windows. However this package +Due to the blocking nature of `STDIN`/`STDOUT`/`STDERR` pipes on Windows we we can +not guarantee this package works as expected on Windows directly. 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. +when you want to run this package on Windows. ## Install