Skip to content

Commit 76b7191

Browse files
committed
fix(docs): Add a note about windows support
Closes #1299
1 parent e83ec4e commit 76b7191

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

.docs/README.hbs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ In addition to reading the [article mentioned above](http://www.voodootikigod.co
8787
| Linux / ARM v8¹ | ☐ | ☐ | ☐ |
8888
| Linux / MIPSel¹ | ☐ | ☐ | ☐ |
8989
| Linux / PPC64¹ | ☐ | ☐ | ☐ |
90-
| Windows² / x86 | | ☑ | ☑ |
90+
| Windows² / x86 | | ☑ | ☑ |
9191
| Windows² / x64 | ☑ | ☑ | ☑ |
9292
| OSX³ / x64 | ☑ | ☑ | ☑ |
9393

@@ -97,6 +97,8 @@ In addition to reading the [article mentioned above](http://www.voodootikigod.co
9797

9898
³ OSX 10.4 Tiger and above are supported, but our CI tests only 10.9.5 Mavericks with Xcode 6.1.
9999

100+
Until Issue #1221 is closed windows will suffer high cpu reads and writes and will require a `UV_THREADPOOL_SIZE` environment variable to be set to 1 + the number of ports you wish to open at a time. (Defaults to `4` which supports 3 ports).
101+
100102
## Installation Instructions
101103

102104
For most "standard" use cases (Node v4.x on Mac, Linux, or Windows on a x86 or x64 processor), Node-Serialport will install nice and easy with:

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ In addition to reading the [article mentioned above](http://www.voodootikigod.co
134134
| Linux / ARM v8¹ ||||
135135
| Linux / MIPSel¹ ||||
136136
| Linux / PPC64¹ ||||
137-
| Windows² / x86 | |||
137+
| Windows² / x86 | |||
138138
| Windows² / x64 ||||
139139
| OSX³ / x64 ||||
140140

@@ -144,6 +144,8 @@ In addition to reading the [article mentioned above](http://www.voodootikigod.co
144144

145145
³ OSX 10.4 Tiger and above are supported, but our CI tests only 10.9.5 Mavericks with Xcode 6.1.
146146

147+
Until Issue #1221 is closed windows will suffer high cpu reads and writes and will require a `UV_THREADPOOL_SIZE` environment variable to be set to 1 + the number of ports you wish to open at a time. (Defaults to `4` which supports 3 ports).
148+
147149
## Installation Instructions
148150

149151
For most "standard" use cases (Node v4.x on Mac, Linux, or Windows on a x86 or x64 processor), Node-Serialport will install nice and easy with:

0 commit comments

Comments
 (0)