5 [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/nodejs/io.js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
7 This repository began as a GitHub fork of
8 [joyent/node](https://github.com/joyent/node).
10 io.js contributions, releases, and contributorship are under an
11 [open governance model](./GOVERNANCE.md).
12 We intend to land, with increasing regularity, releases which are
13 compatible with the npm ecosystem that has been built to date for
16 ## Is it io.js or IO.js or iojs or IOjs or iOjS?
18 The official name is **io.js**, which should never be capitalized,
19 especially not at the start of a sentence, unless it is being
20 displayed in a location that is customarily all-caps (such as
21 the title of man pages).
25 Binaries, installers, and source tarballs are available at
28 **Releases** are available at <https://iojs.org/dist/>, listed under
29 their version string. The <https://iojs.org/dist/latest/> symlink
30 will point to the latest release directory.
32 **Nightly** builds are available at
33 <https://iojs.org/download/nightly/>, listed under their version
34 string which includes their date (in UTC time) and the commit SHA at
35 the HEAD of the release.
37 **API documentation** is available in each release and nightly
38 directory under _docs_. <https://iojs.org/api/> points to the latest version.
40 ### Verifying Binaries
42 Release and nightly download directories all contain a *SHASUM256.txt*
43 file that lists the SHA checksums for each file available for
44 download. To check that a downloaded file matches the checksum, run
45 it through `sha256sum` with a command such as:
48 $ grep iojs-vx.y.z.tar.gz SHASUMS256.txt | sha256sum -c -
51 _(Where "iojs-vx.y.z.tar.gz" is the name of the file you have
54 Additionally, releases (not nightlies) have GPG signed copies of
55 SHASUM256.txt files available as SHASUM256.txt.asc. You can use `gpg`
56 to verify that the file has not been tampered with.
58 To verify a SHASUM256.txt.asc, you will first need to import all of
59 the GPG keys of individuals authorized to create releases. They are
60 listed at the bottom of this README. Use a command such as this to
64 $ gpg --keyserver pool.sks-keyservers.net \
65 --recv-keys DD8F2338BAE7501E3DD5AC78C273792F7D83545D
68 _(Include each of the key fingerprints at the end of this command.)_
70 You can then use `gpg --verify SHASUMS256.txt.asc` to verify that the
71 file has been signed by an authorized member of the io.js team.
73 Once verified, use the SHASUMS256.txt.asc file to get the checksum for
74 the binary verification command above.
82 * `gcc` and `g++` 4.8 or newer, or
83 * `clang` and `clang++` 3.4 or newer
85 * GNU Make 3.81 or newer
86 * libexecinfo (FreeBSD and OpenBSD only)
94 If your Python binary is in a non-standard location or has a
95 non-standard name, run the following instead:
98 $ export PYTHON=/path/to/python
101 $ [sudo] make install
110 To build the documentation:
116 To read the documentation:
126 * [Python 2.6 or 2.7](https://www.python.org/downloads/)
127 * Visual Studio 2013 for Windows Desktop, or
128 * Visual Studio Express 2013 for Windows Desktop
129 * Basic Unix tools required for some tests,
130 [Git for Windows](http://git-scm.com/download/win) includes Git Bash
131 and tools which can be included in the global `PATH`.
143 ### Android / Android based devices, aka. Firefox OS
145 Be sure you have downloaded and extracted [Android NDK]
146 (https://developer.android.com/tools/sdk/ndk/index.html)
147 before in a folder. Then run:
150 $ ./android-configure /path/to/your/android-ndk
154 ### `Intl` (ECMA-402) support:
156 [Intl](https://github.com/joyent/node/wiki/Intl) support is not
159 #### "small" (English only) support
161 This option will build with "small" (English only) support, but
162 the full `Intl` (ECMA-402) APIs. With `--download=all` it will
163 download the ICU library as needed.
168 $ ./configure --with-intl=small-icu --download=all
174 > vcbuild small-icu download-all
177 The `small-icu` mode builds with English-only data. You can add full
180 *Note:* more docs are on
181 [the joyent/node wiki](https://github.com/joyent/node/wiki/Intl).
183 #### Build with full ICU support (all locales supported by ICU):
185 With the `--download=all`, this may download ICU if you don't have an
191 $ ./configure --with-intl=full-icu --download=all
197 > vcbuild full-icu download-all
200 #### Build with no Intl support `:-(`
202 The `Intl` object will not be available. This is the default at
203 present, so this option is not normally needed.
208 $ ./configure --with-intl=none
217 #### Use existing installed ICU (Unix / Macintosh only):
220 $ pkg-config --modversion icu-i18n && ./configure --with-intl=system-icu
223 #### Build with a specific ICU:
225 You can find other ICU releases at
226 [the ICU homepage](http://icu-project.org/download).
227 Download the file named something like `icu4c-**##.#**-src.tgz` (or
233 # from an already-unpacked ICU:
234 $ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu
236 # from a local ICU tarball
237 $ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu.tgz
240 $ ./configure --with-intl=full-icu --with-icu-source=http://url/to/icu.tgz
245 First unpack latest ICU to `deps/icu`
246 [icu4c-**##.#**-src.tgz](http://icu-project.org/download) (or `.zip`)
247 as `deps/icu` (You'll have: `deps/icu/source/...`)
253 # Building io.js with FIPS-compliant OpenSSL
255 NOTE: Windows is not yet supported
257 It is possible to build io.js with
258 [OpenSSL FIPS module](https://www.openssl.org/docs/fips/fipsnotes.html).
262 1. Download and verify `openssl-fips-x.x.x.tar.gz` from
263 https://www.openssl.org/source/
264 2. Extract source to `openssl-fips` folder
265 3. ``cd openssl-fips && ./config fipscanisterbuild --prefix=`pwd`/out``
266 (NOTE: On OS X, you may want to run
267 ``./Configure darwin64-x86_64-cc --prefix=`pwd`/out`` if you are going to
268 build x64-mode io.js)
269 4. `make -j && make install`
270 5. Get into io.js checkout folder
271 6. `./configure --openssl-fips=/path/to/openssl-fips/out`
272 7. Build io.js with `make -j`
273 8. Verify with `node -p "process.versions.openssl"` (`1.0.2a-fips`)
275 ## Resources for Newcomers
277 * [CONTRIBUTING.md](./CONTRIBUTING.md)
278 * [GOVERNANCE.md](./GOVERNANCE.md)
280 [#io.js on Freenode.net](http://webchat.freenode.net?channels=io.js&uio=d4)
281 * [iojs/io.js on Gitter](https://gitter.im/nodejs/io.js)
285 ## Current Project Team Members
287 The io.js project team comprises a group of core collaborators and a sub-group
288 that forms the _Technical Committee_ (TC) which governs the project. For more
289 information about the governance of the io.js project, see
290 [GOVERNANCE.md](./GOVERNANCE.md).
292 * **Isaac Z. Schlueter** <i@izs.me> ([@isaacs](https://github.com/isaacs)) (Technical Committee)
293 * **Ben Noordhuis** <info@bnoordhuis.nl> ([@bnoordhuis](https://github.com/bnoordhuis)) (Technical Committee)
294 * **Bert Belder** <bertbelder@gmail.com> ([@piscisaureus](https://github.com/piscisaureus)) (Technical Committee)
295 * **Fedor Indutny** <fedor.indutny@gmail.com> ([@indutny](https://github.com/indutny)) (Technical Committee)
296 * **Trevor Norris** <trev.norris@gmail.com> ([@trevnorris](https://github.com/trevnorris)) (Technical Committee)
297 * **Chris Dickinson** <christopher.s.dickinson@gmail.com> ([@chrisdickinson](https://github.com/chrisdickinson)) (Technical Committee)
298 - Release GPG key: 9554F04D7259F04124DE6B476D5A82AC7E37093B
299 * **Colin Ihrig** <cjihrig@gmail.com> ([@cjihrig](https://github.com/cjihrig))
300 * **Mikeal Rogers** <mikeal.rogers@gmail.com> ([@mikeal](https://github.com/mikeal))
301 * **Rod Vagg** <rod@vagg.org> ([@rvagg](https://github.com/rvagg)) (Technical Committee)
302 - Release GPG key: DD8F2338BAE7501E3DD5AC78C273792F7D83545D
303 * **Thorsten Lorenz** <thlorenz@gmx.de> ([@thlorenz](https://github.com/thlorenz))
304 * **Stephen Belanger** <admin@stephenbelanger.com> ([@qard](https://github.com/qard))
305 * **Jeremiah Senkpiel** <fishrock123@rocketmail.com> ([@fishrock123](https://github.com/fishrock123)) (Technical Committee)
306 - Release GPG key: FD3A5288F042B6850C66B31F09FE44734EB7990E
307 * **Evan Lucas** <evanlucas@me.com> ([@evanlucas](https://github.com/evanlucas))
308 * **Brendan Ashworth** <brendan.ashworth@me.com> ([@brendanashworth](https://github.com/brendanashworth))
309 * **Vladimir Kurchatkin** <vladimir.kurchatkin@gmail.com> ([@vkurchatkin](https://github.com/vkurchatkin))
310 * **Nikolai Vavilov** <vvnicholas@gmail.com> ([@seishun](https://github.com/seishun))
311 * **Nicu Micleușanu** <micnic90@gmail.com> ([@micnic](https://github.com/micnic))
312 * **Aleksey Smolenchuk** <lxe@lxe.co> ([@lxe](https://github.com/lxe))
313 * **Shigeki Ohtsu** <ohtsu@iij.ad.jp> ([@shigeki](https://github.com/shigeki))
314 * **Sam Roberts** <vieuxtech@gmail.com> ([@sam-github](https://github.com/sam-github))
315 * **Wyatt Preul** <wpreul@gmail.com> ([@geek](https://github.com/geek))
316 * **Brian White** <mscdex@mscdex.net> ([@mscdex](https://github.com/mscdex))
317 * **Christian Tellnes** <christian@tellnes.no> ([@tellnes](https://github.com/tellnes))
318 * **Robert Kowalski** <rok@kowalski.gd> ([@robertkowalski](https://github.com/robertkowalski))
319 * **Julian Duque** <julianduquej@gmail.com> ([@julianduque](https://github.com/julianduque))
320 * **Johan Bergström** <bugs@bergstroem.nu> ([@jbergstroem](https://github.com/jbergstroem))
321 * **Roman Reiss** <me@silverwind.io> ([@silverwind](https://github.com/silverwind))
322 * **Petka Antonov** <petka_antonov@hotmail.com> ([@petkaantonov](https://github.com/petkaantonov))
323 * **Yosuke Furukawa** <yosuke.furukawa@gmail.com> ([@yosuke-furukawa](https://github.com/yosuke-furukawa))
324 * **Alex Kocharin** <alex@kocharin.ru> ([@rlidwka](https://github.com/rlidwka))
325 * **Christopher Monsanto** <chris@monsan.to> ([@monsanto](https://github.com/monsanto))
326 * **Ali Ijaz Sheikh** <ofrobots@google.com> ([@ofrobots](https://github.com/ofrobots))
327 * **Oleg Elifantiev** <oleg@elifantiev.ru> ([@Olegas](https://github.com/Olegas))
328 * **Domenic Denicola** <d@domenic.me> ([@domenic](https://github.com/domenic))
329 * **Rich Trott** <rtrott@gmail.com> ([@Trott](https://github.com/Trott))
330 * **Сковорода Никита Андреевич** <chalkerx@gmail.com> ([@ChALkeR](https://github.com/ChALkeR))
332 Collaborators follow the [COLLABORATOR_GUIDE.md](./COLLABORATOR_GUIDE.md) in
333 maintaining the io.js project.