App-Docs: Document package build command.

about-code · Sep 23, 2017 · 12913e1 · 12913e1
1 parent fab2a39
commit 12913e1
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/generators/project-app/template/README.md b/generators/project-app/template/README.md
@@ -11,6 +11,14 @@
 
 ## Library development (TBD)
 
+- Build packages compatible to [Angular Package Format](https://docs.google.com/document/d/1CZC2rcpxffTDfRDs6p1cfbmKNLA6x5O-NtkJglDaBVs/preview):
+  `npm run build-pkg`
+
+> **Note:** The package build script uses [ng-packagr](https://github.com/dherges/ng-packagr)
+under the hood. If you have issues building packages (e.g. packages with third-party
+dependencies) have a look at [ng-packagr](https://github.com/dherges/ng-packagr)
+docs for details on how to configure `ng-packagr` via `ng-package.json` of the
+respective package.
 
 ## Testing
 

diff --git a/generators/project-app/template/package.json b/generators/project-app/template/package.json
@@ -56,7 +56,7 @@
   "scripts": {
     "clean": "node ./scripts/clean.js",
     "build": "webpack --config ./config/webpack.prod.js",
-    "build:packages": "./scripts/build-packages.js",
+    "build-pkg": "./scripts/build-packages.js",
     "develop": "webpack-dev-server --config ./config/webpack.dev.js --progress",
     "lerna": "lerna",
     "linter-fix": "tslint --fix --project='./tslint.json' --type-check",