summaryrefslogtreecommitdiff
path: root/BUILDING.md
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2016-04-20 10:48:22 -0700
committerRich Trott <rtrott@gmail.com>2016-04-28 10:09:59 -0700
commit153b796d68655e892ce331d9fc7f0477f83db07d (patch)
tree4b119fe2a831f3616b058355c892d938492cebc9 /BUILDING.md
parentbe549899871e1f6d9104e6ac4300550774689819 (diff)
downloadandroid-node-v8-153b796d68655e892ce331d9fc7f0477f83db07d.tar.gz
android-node-v8-153b796d68655e892ce331d9fc7f0477f83db07d.tar.bz2
android-node-v8-153b796d68655e892ce331d9fc7f0477f83db07d.zip
doc: update build instructions for OS X
Building Node.js on OS X requires XCode (because node-gyp requires XCode). Add that information to BUILDING.md. Additionally, this changes references to `Macintosh` in BUILDING.md to refer to `OS X`. This is consistent with the way other references are to operating system families (`Unix`, `Windows`) and not brand names or hardware architectures. PR-URL: https://github.com/nodejs/node/pull/6309 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Johan Bergström <bugs@bergstroem.nu>
Diffstat (limited to 'BUILDING.md')
-rw-r--r--BUILDING.md21
1 files changed, 15 insertions, 6 deletions
diff --git a/BUILDING.md b/BUILDING.md
index a4aa080823..0d55a2047f 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -9,7 +9,7 @@ If you consistently can reproduce a test failure, search for it in the
file a new issue.
-### Unix / Macintosh
+### Unix / OS X
Prerequisites:
@@ -17,8 +17,17 @@ Prerequisites:
* `clang` and `clang++` 3.4 or newer
* Python 2.6 or 2.7
* GNU Make 3.81 or newer
+
+On OS X, you will also need:
+* [Xcode](https://developer.apple.com/xcode/download/)
+ * You also need to install the `Command Line Tools` via Xcode. You can find
+ this under the menu `Xcode -> Preferences -> Downloads`
+ * This step will install `gcc` and the related toolchain containing `make`
+
+On FreeBSD and OpenBSD, you may also need:
* libexecinfo (FreeBSD and OpenBSD only)
+
```text
$ ./configure
$ make
@@ -118,7 +127,7 @@ 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:
+##### Unix / OS X:
```text
$ ./configure --with-intl=small-icu --download=all
@@ -141,7 +150,7 @@ data at runtime.
With the `--download=all`, this may download ICU if you don't have an
ICU in `deps/icu`.
-##### Unix / Macintosh:
+##### Unix / OS X:
```text
$ ./configure --with-intl=full-icu --download=all
@@ -158,7 +167,7 @@ $ ./configure --with-intl=full-icu --download=all
The `Intl` object will not be available. This is the default at
present, so this option is not normally needed.
-##### Unix / Macintosh:
+##### Unix / OS X:
```text
$ ./configure --with-intl=none
@@ -170,7 +179,7 @@ $ ./configure --with-intl=none
> vcbuild intl-none
```
-#### Use existing installed ICU (Unix / Macintosh only):
+#### Use existing installed ICU (Unix / OS X only):
```text
$ pkg-config --modversion icu-i18n && ./configure --with-intl=system-icu
@@ -186,7 +195,7 @@ You can find other ICU releases at
Download the file named something like `icu4c-**##.#**-src.tgz` (or
`.zip`).
-##### Unix / Macintosh
+##### Unix / OS X
```text
# from an already-unpacked ICU: