README.md

   1 io.js
   2 ===
   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)
   4
   5 This repository began as a GitHub fork of
   6 [joyent/node](https://github.com/joyent/node) where contributions,
   7 releases, and contributorship are under an
   8 [open governance model](./CONTRIBUTING.md#governance).
   9
  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.
  12
  13 ### To build:
  14
  15 Prerequisites (Unix only):
  16
  17 * `gcc` and `g++` 4.8 or newer, or
  18 * `clang` and `clang++` 3.3 or newer
  19 * Python 2.6 or 2.7
  20 * GNU Make 3.81 or newer
  21 * libexecinfo (FreeBSD and OpenBSD only)
  22
  23 Unix/Macintosh:
  24
  25 ```sh
  26 ./configure
  27 make
  28 make install
  29 ```
  30
  31 If your python binary is in a non-standard location or has a
  32 non-standard name, run the following instead:
  33
  34 ```sh
  35 export PYTHON=/path/to/python
  36 $PYTHON ./configure
  37 make
  38 make install
  39 ```
  40
  41 Prerequisites (Windows only):
  42
  43 * Python 2.6 or 2.7
  44 * Visual Studio 2013 for Windows Desktop, or
  45 * Visual Studio Express 2013 for Windows Desktop
  46
  47 Windows:
  48
  49 ```sh
  50 vcbuild nosign
  51 ```
  52
  53 You can download pre-built binaries for various operating systems from
  54 [http://nodejs.org/download/](http://nodejs.org/download/).  The Windows
  55 and OS X installers will prompt you for the location in which to install.
  56 The tarballs are self-contained; you can extract them to a local directory
  57 with:
  58
  59 ```sh
  60 tar xzf /path/to/node-<version>-<platform>-<arch>.tar.gz
  61 ```
  62
  63 Or system-wide with:
  64
  65 ```sh
  66 cd /usr/local && tar --strip-components 1 -xzf \
  67                     /path/to/node-<version>-<platform>-<arch>.tar.gz
  68 ```
  69
  70 ### To run the tests:
  71
  72 Unix/Macintosh:
  73
  74 ```sh
  75 make test
  76 ```
  77
  78 Windows:
  79
  80 ```sh
  81 vcbuild test
  82 ```
  83
  84 ### To build the documentation:
  85
  86 ```sh
  87 make doc
  88 ```
  89
  90 ### To read the documentation:
  91
  92 ```sh
  93 man doc/node.1
  94 ```
  95
  96 ### To build `Intl` (ECMA-402) support:
  97
  98 *Note:* more docs, including how to reduce disk footprint, are on
  99 [the wiki](https://github.com/joyent/node/wiki/Intl).
 100
 101 #### Use existing installed ICU (Unix/Macintosh only):
 102
 103 ```sh
 104 pkg-config --modversion icu-i18n && ./configure --with-intl=system-icu
 105 ```
 106
 107 #### Build ICU from source:
 108
 109 First: Unpack latest ICU
 110   [icu4c-**##.#**-src.tgz](http://icu-project.org/download) (or `.zip`)
 111   as `deps/icu` (You'll have: `deps/icu/source/...`)
 112
 113 Unix/Macintosh:
 114
 115 ```sh
 116 ./configure --with-intl=full-icu
 117 ```
 118
 119 Windows:
 120
 121 ```sh
 122 vcbuild full-icu
 123 ```
 124
 125 Resources for Newcomers
 126 ---
 127   - [The Wiki](https://github.com/joyent/node/wiki)
 128   - [nodejs.org](http://nodejs.org/)
 129   - [how to install node.js and npm (node package manager)](http://www.joyent.com/blog/installing-node-and-npm/)
 130   - [list of modules](https://github.com/joyent/node/wiki/modules)
 131   - [searching the npm registry](http://npmjs.org/)
 132   - [list of companies and projects using node](https://github.com/joyent/node/wiki/Projects,-Applications,-and-Companies-Using-Node)
 133   - [node.js mailing list](http://groups.google.com/group/nodejs)
 134   - irc chatroom, [#io.js on freenode.net](http://webchat.freenode.net?channels=io.js&uio=d4)
 135   - [community](https://github.com/joyent/node/wiki/Community)
 136   - [contributing](https://github.com/joyent/node/wiki/Contributing)
 137   - [big list of all the helpful wiki pages](https://github.com/joyent/node/wiki/_pages)