Skip to content

Commit

Permalink
Improve build instructions (denoland#1593)
Browse files Browse the repository at this point in the history
  • Loading branch information
TimvdLippe authored and ry committed Jan 31, 2019
1 parent 0be9d1f commit c7b5312
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 7 deletions.
25 changes: 18 additions & 7 deletions Docs.md
Expand Up @@ -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:

Expand All @@ -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

Expand Down
5 changes: 5 additions & 0 deletions README.md
Expand Up @@ -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
Expand Down

0 comments on commit c7b5312

Please sign in to comment.