Skip to content

Commit f032479

Browse files
Update README
1 parent a36161b commit f032479

2 files changed

Lines changed: 16 additions & 16 deletions

File tree

README.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,27 +27,26 @@ This project was generated with [Angular CLI](https://github.com/angular/angular
2727
They take a long time. If you do `npm run build` expect it to take 10-15 minutes. This can be changed based on changing the build params in the `package.json`.
2828

2929

30-
* * *
30+
## Automated quality enforcment
3131

32-
The following instructions came from the Angular CLI, I haven't tested them yet though.
33-
34-
* * *
32+
1. **Linting:** `npm run lint` - tslint.json
33+
1. **Unit tests:** `npm test` - [Karma](https://karma-runner.github.io).
34+
1. **End-to-end:** `npm run e2e` - Accepting PR to fix these tests. [Protractor](http://www.protractortest.org/).
3535

3636

3737
## Code scaffolding
3838

39-
1. `npm install -g @angular/cli`
40-
1. Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
41-
42-
43-
## Running unit tests
44-
45-
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
46-
47-
48-
## Running end-to-end tests
49-
50-
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
39+
[Docs](https://angular.io/cli/generate)
40+
41+
1. `npm run generate -- component component-name` to generate a new component.
42+
1. `npm run generate -- directive directive-name` to generate a new directive.
43+
1. `npm run generate -- pipe pipe-name` to generate a new pipe.
44+
1. `npm run generate -- service service-name` to generate a new service.
45+
1. `npm run generate -- class class-name` to generate a new class.
46+
1. `npm run generate -- guard guard-name` to generate a new guard.
47+
1. `npm run generate -- interface interface-name` to generate a new interface.
48+
1. `npm run generate -- enum enum-name` to generate a new enum.
49+
1. `npm run generate -- module module-name` to generate a new module.
5150

5251

5352
## Further help

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
"build:ng": "ng build --prod --output-path ./dist-ng",
2020
"build:nw": "build --concurrent --tasks win-x86,linux-x86,linux-x64,mac-x64 --mirror https://dl.nwjs.io/ .",
2121
"run:win": "dist\\nw-angular-1.0.0-win-x86\\nw-angular.exe",
22+
"generate": "ng generate",
2223
"test": "ng test",
2324
"lint": "ng lint",
2425
"e2e": "ng e2e"

0 commit comments

Comments
 (0)