chore(README): describe the different `sync-and-...` gulp tasks

This commit is contained in:
Peter Bacon Darwin 2015-11-13 16:54:46 +00:00 committed by Ward Bell
parent eb7533a6ef
commit 7ac04e446b
1 changed files with 8 additions and 1 deletions

View File

@ -8,7 +8,7 @@ Angular.io is currently the preview site for Angular 2. This site also includes
## Development Setup
1. install [nvm](https://github.com/creationix/nvm)
2. Clone this repo and [angular](https://github.com/angular/angular) on the same parent directory
2. clone this repo and [angular](https://github.com/angular/angular) on the same parent directory
3. cd into root directory `angular.io/`
4. make sure you are using the latest node and npm by running `nvm use 4`.
5. install local packages by running `npm install`
@ -18,6 +18,13 @@ Angular.io is currently the preview site for Angular 2. This site also includes
2. run `gulp serve-and-sync`
3. browser will launch on localhost:3000 and stay refreshed automatically.
If you are only going to work on a specific part of the docs, such as the API or dev guide, then you can use one of the more specific gulp tasks to only watch those parts of the file system:
* `serve-and-sync` : watch all the local Jade/Sass files, the API source and examples, and the dev guide files
* `serve-and-sync-api-docs` : watch only the API source and example files
* `serve-and-sync-devGuide` : watch only the dev guide files
* `build-and-serve` : watch only the local Jade/Sass files
## Technology Used
- Angular 1.x: The production ready version of Angular
- Angular Material: An implementation of Material Design in Angular.js