iSharkFly-Docs/angular-docs-cn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: update README with latest additions

Browse Source 
closes #1820
This commit is contained in:
Foxandxss 2016-07-04 15:54:11 +02:00 committed by Ward Bell
parent b0e0d94b5c
commit 266400b44b
3 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.travis.yml
View File

@ -17,13 +17,13 @@ env:
matrix: matrix:
fast_finish: true fast_finish: true
allow_failures: allow_failures:
- env: "SCRIPT=\"run-e2e-tests --fast\" PREVIEW=true" - env: "SCRIPT=\"run-e2e-tests --fast\" PREVIEW=true"
before_install: before_install:
- npm install -g gulp --no-optional - npm install -g gulp --no-optional
before_script: before_script:
- sh -e /etc/init.d/xvfb start - sh -e /etc/init.d/xvfb start
install: 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 - 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: script:
- gulp $SCRIPT - gulp $SCRIPT

13
README.md
View File

@ -27,7 +27,7 @@ This site relies heavily on node and npm.
1. Make sure you are using the latest 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. 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. 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. 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 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 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` - `gulp lint`
### Sample end-to-end tests ### 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. 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 ## Technology Used
- Angular 1.x: The production ready version of Angular - Angular 1.x: The production ready version of Angular

0
script/install.sh → scripts/install.sh
View File