From 3d92f5107e5e040d04bee339c210ff11b7f674ec Mon Sep 17 00:00:00 2001
From: Hans <hans@hansl.ca>
Date: Wed, 6 Jun 2018 12:31:37 -0700
Subject: [PATCH] release: rewrite the README slightly and reorder packages
---
.monorepo.json | 2 ++
README.md | 18 ++++++++++++----
packages/angular/cli/README.md | 1 -
scripts/templates/readme.ejs | 39 ++++++++++++++++++++++++++++++----
4 files changed, 51 insertions(+), 9 deletions(-)
diff --git a/.monorepo.json b/.monorepo.json
index 388282627d..ade509fae9 100644
--- a/.monorepo.json
+++ b/.monorepo.json
@@ -51,6 +51,7 @@
},
"@angular/cli": {
"name": "Angular CLI",
+ "section": "Tooling",
"links": [
{
"label": "README",
@@ -158,6 +159,7 @@
},
"@angular-devkit/schematics-cli": {
"name": "Schematics CLI",
+ "section": "Tooling",
"version": "0.7.0-beta.1",
"hash": "9af2b27b3c56da136d5ce9f9cfec0208",
"snapshotRepo": "angular/angular-devkit-schematics-cli-builds"
diff --git a/README.md b/README.md
index ec14bf4cc3..69d7815d3e 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,9 @@
# Angular DevKit
### Development tools and libraries specialized for Angular
+This is the home of the DevKit and the Angular CLI code. You can find the Angular CLI specific README
+[here](https://github.com/angular/angular-cli/blob/master/packages/angular/cli/README.md).
+
[](https://circleci.com/gh/angular/angular-cli) [](https://david-dm.org/angular/angular-cli) [](https://david-dm.org/angular/angular-cli?type=dev)
@@ -41,16 +44,24 @@ as it is today will become one of many interfaces available to perform those tas
will also be available to third party tools and IDEs.
+
+
+## Tools
+
+| Project | Package | Version | Links |
+|---|---|---|---|
+**Angular CLI** | [`@angular/cli`](https://npmjs.com/package/@angular/cli) | [](https://npmjs.com/package/@angular/cli) | [](https://github.com/angular/angular-cli/blob/master/packages/angular/cli/README.md) [](https://github.com/angular/cli-builds)
+**Schematics CLI** | [`@angular-devkit/schematics-cli`](https://npmjs.com/package/@angular-devkit/schematics-cli) | [](https://npmjs.com/package/@angular-devkit/schematics-cli) | [](https://github.com/angular/angular-devkit-schematics-cli-builds)
+
+
+
## Packages
This is a monorepo which contains many packages:
-
-
| Project | Package | Version | Links |
|---|---|---|---|
-**Angular CLI** | [`@angular/cli`](https://npmjs.com/package/@angular/cli) | [](https://npmjs.com/package/@angular/cli) | [](https://github.com/angular/angular-cli/blob/master/packages/angular/cli/README.md) [](https://github.com/angular/cli-builds)
**Architect** | [`@angular-devkit/architect`](https://npmjs.com/package/@angular-devkit/architect) | [](https://npmjs.com/package/@angular-devkit/architect) | [](https://github.com/angular/angular-cli/blob/master/packages/angular_devkit/architect/README.md) [](https://github.com/angular/angular-devkit-architect-builds)
**Architect CLI** | [`@angular-devkit/architect-cli`](https://npmjs.com/package/@angular-devkit/architect-cli) | [](https://npmjs.com/package/@angular-devkit/architect-cli) | [](https://github.com/angular/angular-devkit-architect-cli-builds)
**Build Angular** | [`@angular-devkit/build-angular`](https://npmjs.com/package/@angular-devkit/build-angular) | [](https://npmjs.com/package/@angular-devkit/build-angular) | [](https://github.com/angular/angular-cli/blob/master/packages/angular_devkit/build_angular/README.md) [](https://github.com/angular/angular-devkit-build-angular-builds)
@@ -59,7 +70,6 @@ This is a monorepo which contains many packages:
**Build Webpack** | [`@angular-devkit/build-webpack`](https://npmjs.com/package/@angular-devkit/build-webpack) | [](https://npmjs.com/package/@angular-devkit/build-webpack) | [](https://github.com/angular/angular-cli/blob/master/packages/angular_devkit/build_webpack/README.md) [](https://github.com/angular/angular-devkit-build-webpack-builds)
**Core** | [`@angular-devkit/core`](https://npmjs.com/package/@angular-devkit/core) | [](https://npmjs.com/package/@angular-devkit/core) | [](https://github.com/angular/angular-cli/blob/master/packages/angular_devkit/core/README.md) [](https://github.com/angular/angular-devkit-core-builds)
**Schematics** | [`@angular-devkit/schematics`](https://npmjs.com/package/@angular-devkit/schematics) | [](https://npmjs.com/package/@angular-devkit/schematics) | [](https://github.com/angular/angular-cli/blob/master/packages/angular_devkit/schematics/README.md) [](https://github.com/angular/angular-devkit-schematics-builds)
-**Schematics CLI** | [`@angular-devkit/schematics-cli`](https://npmjs.com/package/@angular-devkit/schematics-cli) | [](https://npmjs.com/package/@angular-devkit/schematics-cli) | [](https://github.com/angular/angular-devkit-schematics-cli-builds)
#### Schematics
diff --git a/packages/angular/cli/README.md b/packages/angular/cli/README.md
index 31e28d9b30..f88010a3f0 100644
--- a/packages/angular/cli/README.md
+++ b/packages/angular/cli/README.md
@@ -1,7 +1,6 @@
## Angular CLI
<!-- Badges section here. -->
-[][travis-badge-url]
[![Dependency Status][david-badge]][david-badge-url]
[![devDependency Status][david-dev-badge]][david-dev-badge-url]
diff --git a/scripts/templates/readme.ejs b/scripts/templates/readme.ejs
index 8b7c013cf1..717c4e64b3 100644
--- a/scripts/templates/readme.ejs
+++ b/scripts/templates/readme.ejs
@@ -13,6 +13,9 @@
# Angular DevKit
### Development tools and libraries specialized for Angular
+This is the home of the DevKit and the Angular CLI code. You can find the Angular CLI specific README
+[here](https://github.com/angular/angular-cli/blob/master/packages/angular/cli/README.md).
+
<%# Badges are created here. %>
<% for (const section of monorepo.badges) {
for (const { label, image, title, url } of section) {
@@ -49,16 +52,44 @@ as it is today will become one of many interfaces available to perform those tas
will also be available to third party tools and IDEs.
-## Packages
-This is a monorepo which contains many packages:
-
<%
const sections = [
...new Set(Object.keys(packages).map(pkgName => monorepo.packages[pkgName].section ))
- ].filter(x => x);
+ ].filter(x => x && x != 'Tooling');
sections.unshift(undefined);
%>
+## Tools
+
+| Project | Package | Version | Links |
+|---|---|---|---|
+<%
+for (const pkgName of Object.keys(packages)) {
+ const pkg = packages[pkgName];
+ const mrPkg = monorepo.packages[pkgName];
+
+ if (pkg.private) {
+ continue;
+ }
+ if (mrPkg.section != 'Tooling') {
+ continue;
+ }
+
+%>**<%= mrPkg.name%>**<%
+ %> | [`<%= pkgName %>`](https://npmjs.com/package/<%= pkgName %>)<%
+ %> | [ %>/latest.svg)](https://npmjs.com/package/<%= pkgName %>)<%
+ %> | <% for (const link of mrPkg.links || []) {
+%>[](<%= link.url %>)<%
+}
+if (mrPkg.snapshotRepo) {
+%> [](https://github.com/<%= mrPkg.snapshotRepo %>)<%
+} %>
+<% } %>
+
+
+## Packages
+This is a monorepo which contains many packages:
+
<% for (const section of sections) {
%><%= section ? '#### ' + section : '' %>