summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim van der Lippe <TimvdLippe@users.noreply.github.com>2019-01-31 18:00:17 +0000
committerRyan Dahl <ry@tinyclouds.org>2019-01-31 13:00:17 -0500
commitc7b53125c38c397737da9c17500640cc0670e482 (patch)
treed4ee61446fb3eabc82791ca387aaaabbb2664fab
parent0be9d1ff0e2d07df82698661265c28a75603b5fe (diff)
Improve build instructions (#1593)
-rw-r--r--Docs.md25
-rw-r--r--README.md5
2 files changed, 23 insertions, 7 deletions
diff --git a/Docs.md b/Docs.md
index 50887160d..06f4ca990 100644
--- a/Docs.md
+++ b/Docs.md
@@ -319,13 +319,20 @@ submodule. However, you need to install separately:
[Not 3](https://github.com/denoland/deno/issues/464#issuecomment-411795578).
4. [ccache](https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/ccache)
(Optional but helpful for speeding up rebuilds of V8.)
-5. Extra steps for Windows users:
- 1. Add `python.exe` to `PATH` (e.g. `set PATH=%PATH%;C:\Python27\python.exe`)
- 2. Get [VS Community 2017](https://www.visualstudio.com/downloads/). Make
- sure to select the option to install C++ tools and the Windows SDK.
- 3. Enable `Debugging Tools for Windows`. Go to `Control Panel` ->
- `Windows 10 SDK` -> Right-Click -> `Change` -> `Change` ->
- `Check Debugging Tools for Windows` -> `Change` -> `Finish`.
+
+Extra steps for Mac users:
+
+1. [XCode](https://developer.apple.com/xcode/)
+2. Openssl 1.1: `brew install openssl@1.1` (TODO: shouldn't be necessary)
+
+Extra steps for Windows users:
+
+1. Add `python.exe` to `PATH` (e.g. `set PATH=%PATH%;C:\Python27\python.exe`)
+2. Get [VS Community 2017](https://www.visualstudio.com/downloads/). Make sure
+ to select the option to install C++ tools and the Windows SDK.
+3. Enable `Debugging Tools for Windows`. Go to `Control Panel` ->
+ `Windows 10 SDK` -> Right-Click -> `Change` -> `Change` ->
+ `Check Debugging Tools for Windows` -> `Change` -> `Finish`.
### Build:
@@ -334,6 +341,10 @@ submodule. However, you need to install separately:
cd deno
./tools/setup.py
+ # You may need to ensure that sccache is running.
+ # (TODO it's unclear if this is necessary or not.)
+ # prebuilt/mac/sccache --start-server
+
# Build.
./tools/build.py
diff --git a/README.md b/README.md
index 1992cdcc6..2638c53d4 100644
--- a/README.md
+++ b/README.md
@@ -85,6 +85,11 @@ Try it:
See [deno_install](https://github.com/denoland/deno_install) for more
installation methods..
+## Build locally (advanced users only)
+
+For instructions to build this project locally, please see
+[the docs](https://github.com/denoland/deno/blob/master/Docs.md#build-instructions-for-advanced-users-only).
+
<!-- prettier-ignore -->
[avy badge]: https://ci.appveyor.com/api/projects/status/yel7wtcqwoy0to8x?branch=master&svg=true
[avy link]: https://ci.appveyor.com/project/deno/deno