3 [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/iojs/io.js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
5 This repository began as a GitHub fork of
6 [joyent/node](https://github.com/joyent/node).
8 io.js contributions, releases, and contributorship are under an
9 [open governance model](./GOVERNANCE.md).
10 We intend to land, with increasing regularity, releases which are
11 compatible with the npm ecosystem that has been built to date for Node.js.
13 ## Is it io.js or IO.js or iojs or IOjs or iOjS?
15 The official name is **io.js**, which should never be capitalized,
16 especially not at the start of a sentence, unless it is being
17 displayed in a location that is customarily all-caps (such as
18 the title of man pages).
26 * `gcc` and `g++` 4.8 or newer, or
27 * `clang` and `clang++` 3.3 or newer
29 * GNU Make 3.81 or newer
30 * libexecinfo (FreeBSD and OpenBSD only)
38 If your Python binary is in a non-standard location or has a
39 non-standard name, run the following instead:
42 $ export PYTHON=/path/to/python
54 To build the documentation:
60 To read the documentation:
70 * [Python 2.6 or 2.7](https://www.python.org/downloads/)
71 * Visual Studio 2013 for Windows Desktop, or
72 * Visual Studio Express 2013 for Windows Desktop
73 * Basic Unix tools required for some tests,
74 [Git for Windows](http://git-scm.com/download/win) includes Git Bash
75 and tools which can be included in the global `PATH`.
87 ### `Intl` (ECMA-402) support:
89 [Intl](https://github.com/joyent/node/wiki/Intl) support is not
92 #### "small" (English only) support
94 This option will build with "small" (English only) support, but
95 the full `Intl` (ECMA-402) APIs. With `--download=all` it will
96 download the ICU library as needed.
101 $ ./configure --with-intl=small-icu --download=all
107 > vcbuild small-icu download-all
110 The `small-icu` mode builds with English-only data. You can add full
113 *Note:* more docs are on
114 [the joyent/node wiki](https://github.com/joyent/node/wiki/Intl).
116 #### Build with full ICU support (all locales supported by ICU):
118 With the `--download=all`, this may download ICU if you don't have an
124 $ ./configure --with-intl=full-icu --download=all
130 > vcbuild full-icu download-all
133 #### Build with no Intl support `:-(`
135 The `Intl` object will not be available. This is the default at
136 present, so this option is not normally needed.
141 $ ./configure --with-intl=none
150 #### Use existing installed ICU (Unix / Macintosh only):
153 $ pkg-config --modversion icu-i18n && ./configure --with-intl=system-icu
156 #### Build with a specific ICU:
158 You can find other ICU releases at
159 [the ICU homepage](http://icu-project.org/download).
160 Download the file named something like `icu4c-**##.#**-src.tgz` (or
166 # from an already-unpacked ICU:
167 $ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu
169 # from a local ICU tarball
170 $ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu.tgz
173 $ ./configure --with-intl=full-icu --with-icu-source=http://url/to/icu.tgz
178 First unpack latest ICU to `deps/icu`
179 [icu4c-**##.#**-src.tgz](http://icu-project.org/download) (or `.zip`)
180 as `deps/icu` (You'll have: `deps/icu/source/...`)
186 ## Resources for Newcomers
188 * [CONTRIBUTING.md](./CONTRIBUTING.md)
189 * [GOVERNANCE.md](./GOVERNANCE.md)
191 [#io.js on Freenode.net](http://webchat.freenode.net?channels=io.js&uio=d4)
192 * [iojs/io.js on Gitter](https://gitter.im/iojs/io.js)
196 ## Current Project Team Members
198 The io.js project team comprises a group of core collaborators and a sub-group
199 that forms the _Technical Committee_ (TC) which governs the project. For more
200 information about the governance of the io.js project, see
201 [GOVERNANCE.md](./GOVERNANCE.md).
203 * **Isaac Z. Schlueter** ([@isaacs](https://github.com/isaacs)) <i@izs.me> (Technical Committee)
204 * **Ben Noordhuis** ([@bnoordhuis](https://github.com/bnoordhuis)) <info@bnoordhuis.nl> (Technical Committee)
205 * **Bert Belder** ([@piscisaureus](https://github.com/piscisaureus)) <bertbelder@gmail.com> (Technical Committee)
206 * **Fedor Indutny** ([@indutny](https://github.com/indutny)) <fedor.indutny@gmail.com> (Technical Committee)
207 * **Trevor Norris** ([@trevnorris](https://github.com/trevnorris)) <trev.norris@gmail.com> (Technical Committee)
208 * **Chris Dickinson** ([@chrisdickinson](https://github.com/chrisdickinson)) <christopher.s.dickinson@gmail.com> (Technical Committee)
209 * **Colin Ihrig** ([@cjihrig](https://github.com/cjihrig)) <cjihrig@gmail.com> (Technical Committee)
210 * **Mikeal Rogers** ([@mikeal](https://github.com/mikeal)) <mikeal.rogers@gmail.com>
211 * **Rod Vagg** ([@rvagg](https://github.com/rvagg)) <rod@vagg.org>
213 Collaborators follow the [COLLABORATOR_GUIDE.md](./COLLABORATOR_GUIDE.md) in
214 maintaining the io.js project.