README.md

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