Skip to content

Commit

Permalink
Merge pull request #54 from clue-labs/windows
Browse files Browse the repository at this point in the history
Async console I/O is not supported on Microsoft Windows
  • Loading branch information
clue authored Oct 31, 2017
2 parents ad53a4d + 5a56785 commit 0cf3696
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -555,6 +555,19 @@ $ 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).
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

To run the test suite, you first need to clone this repo and then install all
Expand Down

0 comments on commit 0cf3696

Please sign in to comment.