Skip to content

Commit 3d27986

Browse files
hanslhansl
committed
docs: add getting started section to README
1 parent 202117a commit 3d27986

File tree

3 files changed

+66
-14
lines changed

3 files changed

+66
-14
lines changed

‎CONTRIBUTING.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,19 @@ Help us keep Angular open and inclusive. Please read and follow our [Code of Con
1818

1919
## <a name="question"></a> Got a Question or Problem?
2020

21-
Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on [StackOverflow](https://stackoverflow.com/questions/tagged/angular-devkit) where the questions should be tagged with tag `angular-devkit`.
21+
Please, do not open issues for the general support questions as we want to keep GitHub issues for
22+
bug reports and feature requests. You've got much better chances of getting your question answered
23+
on [StackOverflow](https://stackoverflow.com/questions/tagged/angular-devkit) where the questions
24+
should be tagged with tag `angular-cli` or `angular-devkit`.
2225

2326
StackOverflow is a much better place to ask questions since:
2427

2528
- there are thousands of people willing to help on StackOverflow
2629
- questions and answers stay available for public viewing so your question / answer might help someone else
2730
- StackOverflow's voting system assures that the best answers are prominently visible.
2831

29-
To save your and our time we will be systematically closing all the issues that are requests for general support and redirecting people to StackOverflow.
32+
To save your and our time we will be systematically closing all the issues that are requests for
33+
general support and redirecting people to StackOverflow.
3034

3135
If you would like to chat about the question in real-time, you can reach out via [our gitter channel][gitter].
3236

‎README.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
Any changes to README.md directly will result in a failure on CI.
1111
-->
1212

13-
# Angular DevKit
13+
# Angular CLI
1414
### Development tools and libraries specialized for Angular
1515

1616
This is the home of the DevKit and the Angular CLI code. You can find the Angular CLI specific README
@@ -41,20 +41,44 @@ Angular DevKit.
4141
DevKit's goal is to provide a large set of libraries that can be used to manage, develop, deploy and
4242
analyze your code.
4343

44+
# Getting Started - Local Development
4445

46+
## Installation
47+
To get started locally, follow these instructions:
4548

46-
# Tools
49+
1. If you haven't done it already, [make a fork of this repo](https://github.com/angular/angular-cli/fork).
50+
1. Clone to your local computer using `git`.
51+
1. Make sure that you have Node 10.9 or later installed. See instructions [here](https://nodejs.org/en/download/). The Angular CLI requires Node 8, but development requires Node 10.
52+
1. Make sure that you have `yarn` installed; see instructions [here](https://yarnpkg.com/lang/en/docs/install/).
53+
1. Run `yarn` (no arguments) from the root of your clone of this project.
54+
1. Run `yarn link` to add all custom scripts we use to your global install.
55+
56+
## Creating New Packages
57+
Adding a package to this repository means running two separate commands:
58+
59+
1. `schematics devkit:package PACKAGE_NAME`. This will update the `.monorepo` file, and create the
60+
base files for the new package (package.json, src/index, etc).
61+
1. `devkit-admin templates`. This will update the README and all other template files that might
62+
have changed when adding a new package.
63+
64+
For private packages, you will need to add a `"private": true` key to your package.json manually.
65+
This will require re-running the template admin script.
66+
67+
# Packages
68+
69+
This is a monorepo which contains many tools and packages:
70+
71+
72+
73+
## Tools
4774

4875
| Project | Package | Version | Links |
4976
|---|---|---|---|
5077
**Angular CLI** | [`@angular/cli`](https://npmjs.com/package/@angular/cli) | [![latest](https://img.shields.io/npm/v/%40angular%2Fcli/latest.svg)](https://npmjs.com/package/@angular/cli) | [![README](https://img.shields.io/badge/README--green.svg)](https://github.com/angular/angular-cli/blob/master/packages/angular/cli/README.md) [![snapshot](https://img.shields.io/badge/snapshot--blue.svg)](https://github.com/angular/cli-builds)
5178
**Schematics CLI** | [`@angular-devkit/schematics-cli`](https://npmjs.com/package/@angular-devkit/schematics-cli) | [![latest](https://img.shields.io/npm/v/%40angular-devkit%2Fschematics-cli/latest.svg)](https://npmjs.com/package/@angular-devkit/schematics-cli) | [![snapshot](https://img.shields.io/badge/snapshot--blue.svg)](https://github.com/angular/angular-devkit-schematics-cli-builds)
5279

5380

54-
55-
# Packages
56-
This is a monorepo which contains many packages:
57-
81+
## Packages
5882

5983

6084
| Project | Package | Version | Links |

‎scripts/templates/readme.ejs

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
Any changes to README.md directly will result in a failure on CI.
1111
-->
1212

13-
# Angular DevKit
13+
# Angular CLI
1414
### Development tools and libraries specialized for Angular
1515

1616
This is the home of the DevKit and the Angular CLI code. You can find the Angular CLI specific README
@@ -49,14 +49,41 @@ Angular DevKit.
4949
DevKit's goal is to provide a large set of libraries that can be used to manage, develop, deploy and
5050
analyze your code.
5151

52+
# Getting Started - Local Development
53+
54+
## Installation
55+
To get started locally, follow these instructions:
56+
57+
1. If you haven't done it already, [make a fork of this repo](https://github.com/angular/angular-cli/fork).
58+
1. Clone to your local computer using `git`.
59+
1. Make sure that you have Node 10.9 or later installed. See instructions [here](https://nodejs.org/en/download/). The Angular CLI requires Node 8, but development requires Node 10.
60+
1. Make sure that you have `yarn` installed; see instructions [here](https://yarnpkg.com/lang/en/docs/install/).
61+
1. Run `yarn` (no arguments) from the root of your clone of this project.
62+
1. Run `yarn link` to add all custom scripts we use to your global install.
63+
64+
## Creating New Packages
65+
Adding a package to this repository means running two separate commands:
66+
67+
1. `schematics devkit:package PACKAGE_NAME`. This will update the `.monorepo` file, and create the
68+
base files for the new package (package.json, src/index, etc).
69+
1. `devkit-admin templates`. This will update the README and all other template files that might
70+
have changed when adding a new package.
71+
72+
For private packages, you will need to add a `"private": true` key to your package.json manually.
73+
This will require re-running the template admin script.
74+
75+
# Packages
76+
77+
This is a monorepo which contains many tools and packages:
78+
5279
<%
5380
const sections = [
5481
...new Set(Object.keys(packages).map(pkgName => monorepo.packages[pkgName].section ))
5582
].filter(x => x && x != 'Tooling');
5683
sections.unshift(undefined);
5784
%>
5885

59-
# Tools
86+
## Tools
6087

6188
| Project | Package | Version | Links |
6289
|---|---|---|---|
@@ -83,10 +110,7 @@ if (mrPkg.snapshotRepo) {
83110
} %>
84111
<% } %>
85112
86-
87-
# Packages
88-
This is a monorepo which contains many packages:
89-
113+
## Packages
90114
<% for (const section of sections) {
91115
92116
%><%= section ? '#### ' + section : '' %>

0 commit comments

Comments
 (0)