You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
libuv is a multi-platform support library with a focus on asynchronous I/O. It
6
-
was primarily developed for use by [Node.js](http://nodejs.org), but it's also
6
+
was primarily developed for use by [Node.js][], but it's also
7
7
used by [Luvit](http://luvit.io/), [Julia](http://julialang.org/),
8
8
[pyuv](https://github.com/saghul/pyuv), and [others](https://github.com/libuv/libuv/wiki/Projects-that-use-libuv).
9
9
@@ -62,24 +62,34 @@ formats.
62
62
63
63
Show different supported building options:
64
64
65
-
$ make help
65
+
```bash
66
+
$ make help
67
+
```
66
68
67
69
Build documentation as HTML:
68
70
69
-
$ make html
71
+
```bash
72
+
$ make html
73
+
```
70
74
71
75
Build documentation as HTML and live reload it when it changes (this requires
72
76
sphinx-autobuild to be installed and is only supported on Unix):
73
77
74
-
$ make livehtml
78
+
```bash
79
+
$ make livehtml
80
+
```
75
81
76
82
Build documentation as man pages:
77
83
78
-
$ make man
84
+
```bash
85
+
$ make man
86
+
```
79
87
80
88
Build documentation as ePub:
81
89
82
-
$ make epub
90
+
```bash
91
+
$ make epub
92
+
```
83
93
84
94
NOTE: Windows users need to use make.bat instead of plain 'make'.
85
95
@@ -116,25 +126,32 @@ file, but are also available as git blob objects for easier use.
Git tags are signed with the developer's key, they can be verified as follows:
129
142
130
-
$ git verify-tag v1.6.1
143
+
```bash
144
+
$ git verify-tag v1.6.1
145
+
```
131
146
132
147
Starting with libuv 1.7.0, the tarballs stored in the
133
148
[downloads site](http://dist.libuv.org/dist/) are signed and an accompanying
134
149
signature file sit alongside each. Once both the release tarball and the
135
150
signature file are downloaded, the file can be verified as follows:
136
151
137
-
$ gpg --verify libuv-1.7.0.tar.gz.sign
152
+
```bash
153
+
$ gpg --verify libuv-1.7.0.tar.gz.sign
154
+
```
138
155
139
156
## Build Instructions
140
157
@@ -144,52 +161,100 @@ backends. It is best used for integration into other projects.
144
161
145
162
To build with autotools:
146
163
147
-
$ sh autogen.sh
148
-
$ ./configure
149
-
$ make
150
-
$ make check
151
-
$ make install
164
+
```bash
165
+
$ sh autogen.sh
166
+
$ ./configure
167
+
$ make
168
+
$ make check
169
+
$ make install
170
+
```
152
171
153
172
### Windows
154
173
155
-
First, [Python][] 2.6 or 2.7 must be installed as it is required by [GYP][].
156
-
If python is not in your path, set the environment variable `PYTHON` to its
157
-
location. For example: `set PYTHON=C:\Python27\python.exe`
174
+
Prerequisites:
175
+
176
+
*[Python 2.6 or 2.7][] as it is required
177
+
by [GYP][].
178
+
If python is not in your path, set the environment variable `PYTHON` to its
179
+
location. For example: `set PYTHON=C:\Python27\python.exe`
180
+
* One of:
181
+
*[Visual C++ Build Tools][]
182
+
*[Visual Studio 2015 Update 3][], all editions
183
+
including the Community edition (remember to select
184
+
"Common Tools for Visual C++ 2015" feature during installation).
185
+
*[Visual Studio 2017][], any edition (including the Build Tools SKU).
186
+
**Required Components:** "MSbuild", "VC++ 2017 v141 toolset" and one of the
187
+
Windows SDKs (10 or 8.1).
188
+
* Basic Unix tools required for some tests,
189
+
[Git for Windows][] includes Git Bash
190
+
and tools which can be included in the global `PATH`.
191
+
192
+
To build, launch a git shell (e.g. Cmd or PowerShell), run `vcbuild.bat`
193
+
(to build with VS2017 you need to explicitly add a `vs2017` argument),
194
+
which will checkout the GYP code into `build/gyp`, generate `uv.sln`
195
+
as well as the necesery related project files, and start building.
196
+
197
+
```console
198
+
> vcbuild
199
+
```
200
+
201
+
Or:
202
+
203
+
```console
204
+
> vcbuild vs2017
205
+
```
206
+
207
+
To run the tests:
208
+
209
+
```console
210
+
> vcbuild test
211
+
```
212
+
213
+
To see all the options that could passed to `vcbuild`:
[guidelines for contributing]: https://github.com/libuv/libuv/blob/master/CONTRIBUTING.md
[Python 2.6 or 2.7]: https://www.python.org/downloads/
322
+
[Visual C++ Build Tools]: http://landinghub.visualstudio.com/visual-cpp-build-tools
323
+
[Visual Studio 2015 Update 3]: https://www.visualstudio.com/vs/older-downloads/
324
+
[Visual Studio 2017]: https://www.visualstudio.com/downloads/
325
+
[Git for Windows]: http://git-scm.com/download/win
0 commit comments