Skip to content

docs: update dev instructions for the repo #13890

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 31, 2018
Merged

docs: update dev instructions for the repo #13890

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions DEV_ENVIRONMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# Developer guide: getting your environment set up

1. Make sure you have `node` installed with a version at _least_ 5.5.0.
1. Make sure you have `node` installed with a version at _least_ 10.0.0 and `yarn` with a version
of at least 1.10.0. We recommend using `nvm` to manage your node versions.
2. Run `yarn global add gulp` to install gulp.
3. Fork the `angular/material2` repo.
4. Clone your fork.
3. Fork the `angular/material2` repo on GitHub.
4. Clone your fork to your machine with `git clone`.
Recommendation: name your git remotes `upstream` for `angular/material2`
and `<your-username>` for your fork. Also see the [team git shortcuts](https://github.com/angular/material2/wiki/Team-git----bash-shortcuts).
5. From the root of the project, run `yarn`.
Expand All @@ -20,7 +21,3 @@ and rebuild. The browser should refresh automatically when changes are made.
To run unit tests, run `gulp test`.
To run the e2e tests, run `gulp e2e`.
To run lint, run `gulp lint`.


### Running benchmarks
Not yet implemented.