Skip to content

Commit 0d29f4d

Browse files
JanMalchmmalerba
authored andcommitted
docs: describe dev-env setup for Windows machines (#17467)
* docs: describe dev-env setup for Windows machines Windows machines do not have the required patch command available. The added step explains how to install the package on Windows. Refs #17456 * docs: improve description of Bazel for dev-env setup Refs #17456 * docs: change Material to angular/components
1 parent e58b843 commit 0d29f4d

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

DEV_ENVIRONMENT.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,20 @@
22

33
1. Make sure you have `node` installed with a version at _least_ 10.0.0 and `yarn` with a version
44
of at least 1.10.0. We recommend using `nvm` to manage your node versions.
5-
2. Run `yarn global add gulp` to install gulp.
6-
3. Fork the `angular/components` repo on GitHub.
7-
4. Clone your fork to your machine with `git clone`.
5+
2. angular/components uses Bazel which requires certain Bash and UNIX tools.
6+
- On Windows: Follow the [instructions](https://docs.bazel.build/versions/master/install-windows.html#5-optional-install-compilers-and-language-runtimes)
7+
to install [`MSYS2`](https://www.msys2.org/) and the listed "Common MSYS2 packages".
8+
Afterwards add `C:\msys64\usr\bin` to the `PATH` environment variable.
9+
3. Run `yarn global add gulp` to install gulp.
10+
4. Fork the `angular/components` repo on GitHub.
11+
5. Clone your fork to your machine with `git clone`.
812
Recommendation: name your git remotes `upstream` for `angular/components`
913
and `<your-username>` for your fork. Also see the [team git shortcuts](https://github.com/angular/components/wiki/Team-git----bash-shortcuts).
10-
5. From the root of the project, run `yarn`.
14+
6. From the root of the project, run `yarn`.
1115

1216

13-
To build Material in dev mode, run `gulp material:build`.
14-
To build Material in release mode, run `gulp material:build-release`
17+
To build angular/components in dev mode, run `gulp material:build`.
18+
To build angular/components in release mode, run `gulp material:build-release`
1519

1620
To bring up a local server, run `yarn dev-app`. This will automatically watch for changes
1721
and rebuild. The browser should refresh automatically when changes are made.

0 commit comments

Comments
 (0)