Skip to content

Commit 6496697

Browse files
committed
Added a note about windows compatibility to the readme
1 parent 5d0047f commit 6496697

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,14 @@ of the actual exit code.
219219
**Note:** This functionality was taken from Symfony's
220220
[Process](https://github.com/symfony/process) compoment.
221221

222+
### Windows Compatibility
223+
224+
Due to the blocking nature of `STDIN`/`STDOUT`/`STDERR` pipes on windows we cannot
225+
guarantee this package works as expected on directly windows. However this package
226+
does work on [`Windows Subsystem for Linux`](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux)
227+
(or WSL) without issues. We suggest [installing WSL](https://msdn.microsoft.com/en-us/commandline/wsl/install_guide)
228+
when you want to run this package on windows.
229+
222230
## Install
223231

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

0 commit comments

Comments
 (0)