From 266400b44bac980331c4a0bccb6be2dbde95e7be Mon Sep 17 00:00:00 2001 From: Foxandxss Date: Mon, 4 Jul 2016 15:54:11 +0200 Subject: [PATCH] chore: update README with latest additions closes #1820 --- .travis.yml | 4 ++-- README.md | 13 +++++++++++-- {script => scripts}/install.sh | 0 3 files changed, 13 insertions(+), 4 deletions(-) rename {script => scripts}/install.sh (100%) diff --git a/.travis.yml b/.travis.yml index f5624c7eb9..b0f7d92a6a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -17,13 +17,13 @@ env: matrix: fast_finish: true allow_failures: - - env: "SCRIPT=\"run-e2e-tests --fast\" PREVIEW=true" + - env: "SCRIPT=\"run-e2e-tests --fast\" PREVIEW=true" before_install: - npm install -g gulp --no-optional before_script: - sh -e /etc/init.d/xvfb start install: - - ./script/install.sh + - ./scripts/install.sh - if [[ $PREVIEW == true ]]; then npm install --prefix public/docs/_examples angular/{core,common,compiler,platform-browser,platform-browser-dynamic,http,forms,router-deprecated,router,upgrade}-builds; fi script: - gulp $SCRIPT diff --git a/README.md b/README.md index 336a589c4a..1e0d3095f5 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ This site relies heavily on node and npm. 1. Make sure you are using the latest node and npm; if not install [nvm](https://github.com/creationix/nvm) to get node going on your machine. -1. install these npm packages *globally*: `npm install -g harp gulp protractor` +1. install these npm packages *globally*: `npm install -g harp gulp` 1. clone this repo and the [angular source code repo](https://github.com/angular/angular) to the same parent directory. The two cloned repo directories must be sibling. @@ -98,7 +98,7 @@ Look at the scripts in `package.json` for other options. Also, open any `plunkr.no-link.html` to see the code execute in plunker (you may have to run `gulp build-plunkers` first to create/update). -You may want to check that your example is free of lint errors. +You must check that your example is free of lint errors. - `gulp lint` ### Sample end-to-end tests @@ -112,6 +112,15 @@ All samples should be covered to some degree by end-to-end tests: Any combination of options is possible. +### Resetting the project +This project generates a lot of untracked files, if you wish to reset it to a mint state, you can run: + +- `git clean -xdf` + +Also, there is a script available for Linux and OSX users that will setup the project using the steps shown in this section: + +- `./scripts/install.sh` + ## Technology Used - Angular 1.x: The production ready version of Angular diff --git a/script/install.sh b/scripts/install.sh similarity index 100% rename from script/install.sh rename to scripts/install.sh