3bc445f6c2
PR-URL: https://github.com/iojs/io.js/pull/1204 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
9.2 KiB
io.js
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).
Download
Binaries, installers, and source tarballs are available at https://iojs.org.
Releases are available at https://iojs.org/dist/, listed under their version string. The https://iojs.org/dist/latest/ symlink will point to the latest release directory.
Nightly builds are available at https://iojs.org/download/nightly/, listed under their version string which includes their date (in UTC time) and the commit SHA at the HEAD of the release.
API documentation is available in each release and nightly directory under docs. https://iojs.org/api/ points to the the latest version.
Verifying Binaries
Release and nightly download directories all contain a SHASUM256.txt
file that lists the SHA checksums for each file available for
download. To check that a downloaded file matches the checksum, run
it through sha256sum with a command such as:
$ grep iojs-vx.y.z.tar.gz SHASUMS256.txt | sha256sum -c -
(Where "iojs-vx.y.z.tar.gz" is the name of the file you have downloaded)
Additionally, releases (not nightlies) have GPG signed copies of
SHASUM256.txt files available as SHASUM256.txt.asc. You can use gpg
to verify that the file has not been tampered with.
To verify a SHASUM256.txt.asc, you will first need to import all of the GPG keys of individuals authorized to create releases. They are listed at the bottom of this README. Use a command such as this to import the keys:
$ gpg --keyserver pool.sks-keyservers.net \
--recv-keys DD8F2338BAE7501E3DD5AC78C273792F7D83545D
(Include each of the key fingerprints at the end of this command.)
You can then use gpg --verify SHASUMS256.txt.asc to verify that the
file has been signed by an authorized member of the io.js team.
Once verified, use the SHASUMS256.txt.asc file to get the checksum for the binary verification command above.
Build
Unix / Macintosh
Prerequisites:
gccandg++4.8 or newer, orclangandclang++3.4 or newer- Python 2.6 or 2.7
- GNU Make 3.81 or newer
- libexecinfo (FreeBSD and OpenBSD only)
$ ./configure
$ make
$ [sudo] 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
$ [sudo] 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)
Release GPG key: 9554F04D7259F04124DE6B476D5A82AC7E37093B - Colin Ihrig (@cjihrig) <cjihrig@gmail.com>
- Mikeal Rogers (@mikeal) <mikeal.rogers@gmail.com>
- Rod Vagg (@rvagg) <rod@vagg.org>
Release GPG key: DD8F2338BAE7501E3DD5AC78C273792F7D83545D - Thorsten Lorenz (@thlorenz) <thlorenz@gmx.de>
- Stephen Belanger (@qard) <admin@stephenbelanger.com>
- Jeremiah Senkpiel (@fishrock123) <fishrock123@rocketmail.com>
- Evan Lucas (@evanlucas) <evanlucas@me.com>
- Brendan Ashworth (@brendanashworth) <brendan.ashworth@me.com>
- Vladimir Kurchatkin (@vkurchatkin) <vladimir.kurchatkin@gmail.com>
- Nikolai Vavilov (@seishun) <vvnicholas@gmail.com>
- Nicu Micleușanu (@micnic) <micnic90@gmail.com>
- Aleksey Smolenchuk (@lxe) <lxe@lxe.co>
- Shigeki Ohtsu (@shigeki) <ohtsu@iij.ad.jp>
- Sam Roberts (@sam-github) <vieuxtech@gmail.com>
- Wyatt Preul (@geek) <wpreul@gmail.com>
- Brian White (@mscdex) <mscdex@mscdex.net>
- Christian Vaagland Tellnes (@tellnes) <christian@tellnes.com>
- Robert Kowalski (@robertkowalski) <rok@kowalski.gd>
- Julian Duque (@julianduque) <julianduquej@gmail.com>
- Johan Bergström (@jbergstroem) <bugs@bergstroem.nu>
- Roman Reiss (@silverwind) <me@silverwind.io>
- Petka Antonov (@petkaantonov) <petka_antonov@hotmail.com>
- Yosuke Furukawa (@yosuke-furukawa) <yosuke.furukawa@gmail.com>
Collaborators follow the COLLABORATOR_GUIDE.md in maintaining the io.js project.