README.md

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