Graham/angular-cli
1
0
Fork 0
mirror of https://github.com/angular/angular-cli.git synced 2025-05-15 10:11:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: add getting started section to README

Browse Source
This commit is contained in:
Hans 2018-10-02 12:28:20 -07:00
parent 202117a68e
commit 3d279861d7
3 changed files with 66 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -18,7 +18,10 @@ Help us keep Angular open and inclusive. Please read and follow our [Code of Con
## <a name="question"></a> Got a Question or Problem?
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`.
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-cli` or `angular-devkit`.
StackOverflow is a much better place to ask questions since:
@ -26,7 +29,8 @@ StackOverflow is a much better place to ask questions since:
- questions and answers stay available for public viewing so your question / answer might help someone else
- StackOverflow's voting system assures that the best answers are prominently visible.
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.
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.
If you would like to chat about the question in real-time, you can reach out via [our gitter channel][gitter].

36
README.md
View File

@ -10,7 +10,7 @@
Any changes to README.md directly will result in a failure on CI.
-->
# Angular DevKit
# Angular CLI
### 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
@ -41,9 +41,36 @@ Angular DevKit.
DevKit's goal is to provide a large set of libraries that can be used to manage, develop, deploy and
analyze your code.
# Getting Started - Local Development
## Installation
To get started locally, follow these instructions:
1. If you haven't done it already, [make a fork of this repo](https://github.com/angular/angular-cli/fork).
1. Clone to your local computer using `git`.
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.
1. Make sure that you have `yarn` installed; see instructions [here](https://yarnpkg.com/lang/en/docs/install/).
1. Run `yarn` (no arguments) from the root of your clone of this project.
1. Run `yarn link` to add all custom scripts we use to your global install.
## Creating New Packages
Adding a package to this repository means running two separate commands:
1. `schematics devkit:package PACKAGE_NAME`. This will update the `.monorepo` file, and create the
base files for the new package (package.json, src/index, etc).
1. `devkit-admin templates`. This will update the README and all other template files that might
have changed when adding a new package.
For private packages, you will need to add a `"private": true` key to your package.json manually.
This will require re-running the template admin script.
# Packages
This is a monorepo which contains many tools and packages:
# Tools
## Tools
| Project | Package | Version | Links |
|---|---|---|---|
@ -51,10 +78,7 @@ analyze your code.
**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)
# Packages
This is a monorepo which contains many packages:
## Packages
| Project | Package | Version | Links |

36
scripts/templates/readme.ejs
View File

@ -10,7 +10,7 @@
Any changes to README.md directly will result in a failure on CI.
-->
# Angular DevKit
# Angular CLI
### 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
@ -49,6 +49,33 @@ Angular DevKit.
DevKit's goal is to provide a large set of libraries that can be used to manage, develop, deploy and
analyze your code.
# Getting Started - Local Development
## Installation
To get started locally, follow these instructions:
1. If you haven't done it already, [make a fork of this repo](https://github.com/angular/angular-cli/fork).
1. Clone to your local computer using `git`.
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.
1. Make sure that you have `yarn` installed; see instructions [here](https://yarnpkg.com/lang/en/docs/install/).
1. Run `yarn` (no arguments) from the root of your clone of this project.
1. Run `yarn link` to add all custom scripts we use to your global install.
## Creating New Packages
Adding a package to this repository means running two separate commands:
1. `schematics devkit:package PACKAGE_NAME`. This will update the `.monorepo` file, and create the
base files for the new package (package.json, src/index, etc).
1. `devkit-admin templates`. This will update the README and all other template files that might
have changed when adding a new package.
For private packages, you will need to add a `"private": true` key to your package.json manually.
This will require re-running the template admin script.
# Packages
This is a monorepo which contains many tools and packages:
<%
const sections = [
...new Set(Object.keys(packages).map(pkgName => monorepo.packages[pkgName].section ))
@ -56,7 +83,7 @@ analyze your code.
sections.unshift(undefined);
%>
# Tools
## Tools
| Project | Package | Version | Links |
|---|---|---|---|
@ -83,10 +110,7 @@ if (mrPkg.snapshotRepo) {
} %>
<% } %>
# Packages
This is a monorepo which contains many packages:
## Packages
<% for (const section of sections) {
%><%= section ? '#### ' + section : '' %>