Skip to content

Commit

Permalink
Add Windows-specific build docs (#68)
Browse files Browse the repository at this point in the history
  • Loading branch information
tebbi authored and mathiasbynens committed Nov 14, 2018
1 parent 1a3945d commit 0c3357b
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Expand Up @@ -13,3 +13,19 @@ This repository hosts the source code of [v8.dev, the official website of the V8
- `npm run build` builds the site into `dist`.
- `npm run watch` builds the site into `dist` and watches for changes.
- `npm start` kicks off a local HTTP server.

### Additional Windows-specific instructions

`npm run` might trigger Unix-specific commands. If you are using a Linux-like environment on Windows like git bash, msys2, or Cygwin, then you must configure npm to use it. This replaces the default behavior of using `cmd.exe`. For example:

```sh
npm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe"
```

…or:

```sh
npm config set script-shell "C:\\msys64\\usr\\bin\\sh.exe"
```

You still need to run `npm` with a `PATH` that includes Linux utilities like `mkdir` and `rm`. Practically, it should work if you run `npm` from your Linux-compatible shell.

0 comments on commit 0c3357b

Please sign in to comment.