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).
7 io.js contributions, releases, and contributorship are under an
8 [open governance model](./CONTRIBUTING.md#governance).
9 We intend to land, with increasing regularity, releases which are
10 compatible with the npm ecosystem that has been built to date for node.js.
12 ### Is it io.js or IO.js or iojs or IOjs or iOjS?
14 The official name is **io.js**, which should never be capitalized,
15 especially not at the start of a sentence, unless it is being
16 displayed in a location that is customarily all-caps (such as
17 the title of man pages.)
21 Prerequisites (Unix only):
23 * `gcc` and `g++` 4.8 or newer, or
24 * `clang` and `clang++` 3.3 or newer
26 * GNU Make 3.81 or newer
27 * libexecinfo (FreeBSD and OpenBSD only)
37 If your python binary is in a non-standard location or has a
38 non-standard name, run the following instead:
41 export PYTHON=/path/to/python
47 Prerequisites (Windows only):
50 * Visual Studio 2013 for Windows Desktop, or
51 * Visual Studio Express 2013 for Windows Desktop
59 You can download pre-built binaries for various operating systems from
60 [http://nodejs.org/download/](http://nodejs.org/download/). The Windows
61 and OS X installers will prompt you for the location in which to install.
62 The tarballs are self-contained; you can extract them to a local directory
66 tar xzf /path/to/node-<version>-<platform>-<arch>.tar.gz
72 cd /usr/local && tar --strip-components 1 -xzf \
73 /path/to/node-<version>-<platform>-<arch>.tar.gz
90 ### To build the documentation:
96 ### To read the documentation:
102 ### To build `Intl` (ECMA-402) support:
104 *Note:* more docs, including how to reduce disk footprint, are on
105 [the wiki](https://github.com/joyent/node/wiki/Intl).
107 #### Use existing installed ICU (Unix/Macintosh only):
110 pkg-config --modversion icu-i18n && ./configure --with-intl=system-icu
113 #### Build ICU from source:
115 First: Unpack latest ICU
116 [icu4c-**##.#**-src.tgz](http://icu-project.org/download) (or `.zip`)
117 as `deps/icu` (You'll have: `deps/icu/source/...`)
122 ./configure --with-intl=full-icu
131 Resources for Newcomers
133 - [The Wiki](https://github.com/joyent/node/wiki)
134 - [nodejs.org](http://nodejs.org/)
135 - [how to install node.js and npm (node package manager)](http://www.joyent.com/blog/installing-node-and-npm/)
136 - [list of modules](https://github.com/joyent/node/wiki/modules)
137 - [searching the npm registry](http://npmjs.org/)
138 - [list of companies and projects using node](https://github.com/joyent/node/wiki/Projects,-Applications,-and-Companies-Using-Node)
139 - [node.js mailing list](http://groups.google.com/group/nodejs)
140 - irc chatroom, [#io.js on freenode.net](http://webchat.freenode.net?channels=io.js&uio=d4)
141 - [community](https://github.com/joyent/node/wiki/Community)
142 - [contributing](https://github.com/joyent/node/wiki/Contributing)
143 - [big list of all the helpful wiki pages](https://github.com/joyent/node/wiki/_pages)