Node.js JavaScript runtime 🐢🚀
Go to file
Rod Vagg 8cf6079a6a doc: update AUTHORS list
Update AUTHORS file using tools/update-authors.sh

PR-URL: https://github.com/iojs/io.js/pull/462
Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
2015-01-16 14:02:30 +11:00
benchmark benchmark: fix command name in benchmark scripts 2015-01-14 02:29:59 +01:00
deps deps: make node-gyp work again on windows 2015-01-15 01:39:30 +01:00
doc doc: fix 404s for syntax highlighting js 2015-01-15 10:09:24 -08:00
lib src: fix jslint errors 2015-01-15 21:21:31 +01:00
src src: fix jslint errors 2015-01-15 21:21:31 +01:00
test test: introduce a test for process.versions output 2015-01-14 12:43:52 +11:00
tools tools: update closure linter to 2.3.17 2015-01-15 21:21:18 +01:00
.gitattributes src: limit .gitattributes eol to vcbuild.bat 2015-01-13 22:33:52 +11:00
.gitignore build: create smaller build artifacts 2015-01-13 14:04:17 +11:00
.mailmap doc: update AUTHORS list 2015-01-16 14:02:30 +11:00
AUTHORS doc: update AUTHORS list 2015-01-16 14:02:30 +11:00
BSDmakefile Tell BSD users to run `gmake` instead. 2011-07-11 14:17:23 +02:00
CHANGELOG.md doc: Add http keepalive behavior to CHANGELOG.md 2015-01-15 17:40:00 -08:00
COLLABORATOR_GUIDE.md doc: clarified & split up contribution docs 2015-01-12 22:24:33 +11:00
CONTRIBUTING.md First draft of a new contribution policy. 2015-01-13 17:21:04 -08:00
GOVERNANCE.md doc: fix broken readme links to collaborator list 2015-01-14 01:10:10 -08:00
LICENSE doc: fix formatting in LICENSE for RTF generation 2015-01-15 19:53:46 +01:00
Makefile doc: fix 404s for syntax highlighting js 2015-01-15 10:09:24 -08:00
Makefile.build src: move debug agent from deps/ to src/ 2014-11-03 12:08:04 +01:00
README.md doc: change link man doc 2015-01-14 16:12:46 +11:00
android-configure build: add android support 2013-06-17 17:21:56 +02:00
common.gypi win: disable stl exception usage 2015-01-08 11:42:10 +01:00
configure build: move armv6 snapshot test to configure_arm() 2015-01-12 16:05:15 +11:00
node.gyp build: fix `process.platform` 2015-01-09 19:52:51 +01:00
vcbuild.bat src: rename node to io.js for Windows installer 2015-01-13 09:44:34 +11:00

README.md

io.js

![Gitter](https://badges.gitter.im/Join Chat.svg)

This repository began as a GitHub fork of joyent/node.

io.js contributions, releases, and contributorship are under an open governance model. We intend to land, with increasing regularity, releases which are compatible with the npm ecosystem that has been built to date for Node.js.

Is it io.js or IO.js or iojs or IOjs or iOjS?

The official name is io.js, which should never be capitalized, especially not at the start of a sentence, unless it is being displayed in a location that is customarily all-caps (such as the title of man pages.)

To build:

Unix / Macintosh

Prerequisites:

  • gcc and g++ 4.8 or newer, or
  • clang and clang++ 3.3 or newer
  • Python 2.6 or 2.7
  • GNU Make 3.81 or newer
  • libexecinfo (FreeBSD and OpenBSD only)
$ ./configure
$ make
$ make install

If your Python binary is in a non-standard location or has a non-standard name, run the following instead:

$ export PYTHON=/path/to/python
$ $PYTHON ./configure
$ make
$ make install

To run the tests:

$ make test

To build the documentation:

$ make doc

To read the documentation:

$ man doc/iojs.1

Windows

Prerequisites:

  • Python 2.6 or 2.7
  • Visual Studio 2013 for Windows Desktop, or
  • Visual Studio Express 2013 for Windows Desktop
  • Basic Unix tools required for some tests, Git for Windows includes Git Bash and tools which can be included in the global PATH.
> vcbuild nosign

To run the tests:

> vcbuild test

Intl (ECMA-402) support:

Intl support is not enabled by default.

"small" (English only) support

This option will build with "small" (English only) support, but the full Intl (ECMA-402) APIs. With --download=all it will download the ICU library as needed.

Unix / Macintosh:

$ ./configure --with-intl=small-icu --download=all

Windows:

> vcbuild small-icu download-all

The small-icu mode builds with English-only data. You can add full data at runtime.

Note: more docs are on the joyent/node wiki.

Build with full ICU support (all locales supported by ICU):

With the --download=all, this may download ICU if you don't have an ICU in deps/icu.

Unix / Macintosh:

$ ./configure --with-intl=full-icu --download=all

Windows:

> vcbuild full-icu download-all

Build with no Intl support :-(

The Intl object will not be available. This is the default at present, so this option is not normally needed.

Unix / Macintosh:

$ ./configure --with-intl=none

Windows:

> vcbuild intl-none

Use existing installed ICU (Unix / Macintosh only):

$ pkg-config --modversion icu-i18n && ./configure --with-intl=system-icu

Build with a specific ICU:

You can find other ICU releases at the ICU homepage. Download the file named something like icu4c-**##.#**-src.tgz (or .zip).

Unix / Macintosh

# from an already-unpacked ICU:
$ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu

# from a local ICU tarball
$ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu.tgz

# from a tarball URL
$ ./configure --with-intl=full-icu --with-icu-source=http://url/to/icu.tgz

Windows

First unpack latest ICU to deps/icu icu4c-##.#-src.tgz (or .zip) as deps/icu (You'll have: deps/icu/source/...)

> vcbuild full-icu

Resources for Newcomers

Current Project Team Members

The io.js project team comprises a group of core collaborators and a sub-group that forms the Technical Committee (TC) which governs the project. For more information about the governance of the io.js project, see GOVERNANCE.md.

  • Isaac Z. Schlueter (@isaacs) <i@izs.me> (Technical Committee)
  • Ben Noordhuis (@bnoordhuis) <info@bnoordhuis.nl> (Technical Committee)
  • Bert Belder (@piscisaureus) <bertbelder@gmail.com> (Technical Committee)
  • Fedor Indutny (@indutny) <fedor.indutny@gmail.com> (Technical Committee)
  • Trevor Norris (@trevnorris) <trev.norris@gmail.com> (Technical Committee)
  • Chris Dickinson (@chrisdickinson) <christopher.s.dickinson@gmail.com> (Technical Committee)
  • Colin Ihrig (@cjihrig) <cjihrig@gmail.com> (Technical Committee)
  • Mikeal Rogers (@mikeal) <mikeal.rogers@gmail.com>
  • Rod Vagg (@rvagg) <rod@vagg.org>

Collaborators follow the COLLABORATOR_GUIDE.md in maintaining the io.js project.