From 8666dc7633e5a7a398fa81242376a3d5610b0526 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20L=C3=BCck?= Date: Tue, 31 Oct 2017 15:57:39 +0100 Subject: [PATCH 1/2] Async console I/O is not supported on Microsoft Windows --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 2391664..9977e01 100644 --- a/README.md +++ b/README.md @@ -555,6 +555,16 @@ $ composer require clue/stdio-react:^1.0 More details and upgrade guides can be found in the [CHANGELOG](CHANGELOG.md). +Note that *Microsoft Windows is not supported*. +Due to platform inconsistencies, PHP does not provide support for reading from +standard console input without blocking. +Unfortunately, until the underlying PHP feature request is implemented (which +is unlikely to happen any time soon), there's little we can do in this library. +A work-around for this remains unknown. +Your only option would be to entirely +[disable interactive input for Microsoft Windows](https://github.com/clue/psocksd/commit/c2f2f90ffc8ebf8233839ba2f3553f2698930125). +See also [#18](https://github.com/clue/php-stdio-react/issues/18) for more details. + ## Tests To run the test suite, you first need to clone this repo and then install all From 5a5678561bc3f296bce5577a27f922acc17f455f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20L=C3=BCck?= Date: Tue, 31 Oct 2017 16:20:32 +0100 Subject: [PATCH 2/2] Suggest Windows Subsystem for Linux (WSL) for Windows users --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 9977e01..d7ea556 100644 --- a/README.md +++ b/README.md @@ -563,6 +563,9 @@ is unlikely to happen any time soon), there's little we can do in this library. A work-around for this remains unknown. Your only option would be to entirely [disable interactive input for Microsoft Windows](https://github.com/clue/psocksd/commit/c2f2f90ffc8ebf8233839ba2f3553f2698930125). +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. See also [#18](https://github.com/clue/php-stdio-react/issues/18) for more details. ## Tests