Skip to content

Commit 3829fb2

Browse files
alan-agius4dgp1130
alan-agius4
authored and
dgp1130
committed
docs: improve readme
Update readme to match that of angular/angular
1 parent 40fb1a1 commit 3829fb2

File tree

5 files changed

+286
-95
lines changed

5 files changed

+286
-95
lines changed

‎.monorepo.json‎

Lines changed: 0 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,4 @@
11
{
2-
"badges": [
3-
[
4-
{
5-
"image": "https://img.shields.io/circleci/project/github/angular/angular-cli/master.svg?label=circleci",
6-
"label": "CircleCI branch",
7-
"url": "https://circleci.com/gh/angular/angular-cli"
8-
},
9-
{
10-
"title": "![Dependency Status](https://david-dm.org/angular/angular-cli.svg)",
11-
"url": "https://david-dm.org/angular/angular-cli"
12-
},
13-
{
14-
"title": "![devDependency Status](https://david-dm.org/angular/angular-cli/dev-status.svg)",
15-
"url": "https://david-dm.org/angular/angular-cli?type=dev"
16-
}
17-
],
18-
[
19-
{
20-
"label": "License",
21-
"image": "https://img.shields.io/npm/l/@angular/cli.svg",
22-
"url": "/LICENSE"
23-
}
24-
],
25-
[
26-
{
27-
"label": "GitHub forks",
28-
"image": "https://img.shields.io/github/forks/angular/angular-cli.svg?style=social&label=Fork",
29-
"url": "https://github.com/angular/angular-cli/fork"
30-
},
31-
{
32-
"label": "GitHub stars",
33-
"image": "https://img.shields.io/github/stars/angular/angular-cli.svg?style=social&label=Star",
34-
"url": "https://github.com/angular/angular-cli"
35-
}
36-
]
37-
],
38-
"links": {
39-
"Gitter": "https://gitter.im/angular/angular-cli",
40-
"Contributing": "/CONTRIBUTING.md",
41-
"Angular CLI": "http://github.com/angular/angular-cli"
42-
},
432
"packages": {
443
"@_/benchmark": {},
454
"@_/builders": {},

‎README.md‎

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

13-
# Angular CLI
14-
### Development tools and libraries specialized for Angular
13+
<h1 align="center">Angular CLI - The CLI tool for Angular.</h1>
1514

16-
This is the home of the DevKit and the Angular CLI code. You can find the Angular CLI specific README
17-
[here](/packages/angular/cli/README.md).
15+
<p align="center">
16+
<br>
17+
<img src="/docs/images/angular-cli-logo.png" alt="Angular CLI logo" width="100px" height="108px"/>
18+
<br><br>
19+
<i>The Angular CLI is a command-line interface tool that you use to initialize, develop, scaffold,
20+
<br>and maintain Angular applications directly from a command shell.</i>
21+
<br>
22+
</p>
1823

24+
<p align="center">
25+
<a href="https://cli.angular.io"><strong>cli.angular.io</strong></a>
26+
<br>
27+
</p>
1928

20-
[![CircleCI branch](https://img.shields.io/circleci/project/github/angular/angular-cli/master.svg?label=circleci)](https://circleci.com/gh/angular/angular-cli) [![Dependency Status](https://david-dm.org/angular/angular-cli.svg)](https://david-dm.org/angular/angular-cli) [![devDependency Status](https://david-dm.org/angular/angular-cli/dev-status.svg)](https://david-dm.org/angular/angular-cli?type=dev)
29+
<p align="center">
30+
<a href="CONTRIBUTING.md">Contributing Guidelines</a>
31+
·
32+
<a href="https://github.com/angular/angular-cli/issues">Submit an Issue</a>
33+
·
34+
<a href="https://blog.angular.io/">Blog</a>
35+
<br>
36+
<br>
37+
</p>
2138

22-
[![License](https://img.shields.io/npm/l/@angular/cli.svg)](/LICENSE)
39+
<p align="center">
40+
<a href="https://circleci.com/gh/angular/workflows/angular-cli/tree/master">
41+
<img src="https://img.shields.io/circleci/build/github/angular/angular-cli/master.svg?logo=circleci&logoColor=fff&label=CircleCI" alt="CI status" />
42+
</a>&nbsp;
43+
<a href="https://discord.gg/angular">
44+
<img src="https://img.shields.io/discord/463752820026376202.svg?logo=discord&logoColor=fff&label=Discord&color=7389d8" alt="Discord conversation" />
45+
</a>
46+
</p>
2347

24-
[![GitHub forks](https://img.shields.io/github/forks/angular/angular-cli.svg?style=social&label=Fork)](https://github.com/angular/angular-cli/fork) [![GitHub stars](https://img.shields.io/github/stars/angular/angular-cli.svg?style=social&label=Star)](https://github.com/angular/angular-cli)
48+
<hr>
2549

50+
## Documentation
2651

52+
Get started with Angular CLI, learn the fundamentals and explore advanced topics on our documentation website.
2753

28-
### Quick Links
29-
[Gitter](https://gitter.im/angular/angular-cli) | [Contributing](/CONTRIBUTING.md) | [Angular CLI](http://github.com/angular/angular-cli) |
30-
|---|---|---|
54+
- [Getting started][quickstart]
55+
- [CLI][cli]
56+
- [Workspace and project file structure][filestructure]
57+
- [Workspace configuration][workspaceconfig]
58+
- [Schematics][schematics]
3159

32-
----
60+
## Development Setup
3361

34-
## The Goal of Angular CLI
3562

36-
The Angular CLI creates, manages, builds and test your Angular projects. It's built on top of the
37-
Angular DevKit.
63+
### Prerequisites
3864

39-
## The Goal of DevKit
65+
- Install [Node.js] which includes [Node Package Manager][npm]
4066

41-
DevKit's goal is to provide a large set of libraries that can be used to manage, develop, deploy and
42-
analyze your code.
67+
### Setting Up a Project
4368

44-
# Packages
69+
Install the Angular CLI globally:
70+
71+
```
72+
npm install -g @angular/cli
73+
```
74+
75+
Create workspace:
76+
77+
```
78+
ng new [PROJECT NAME]
79+
```
80+
81+
Run the application:
82+
83+
```
84+
cd [PROJECT NAME]
85+
ng serve
86+
```
87+
88+
Angular is cross-platform, fast, scalable, has incredible tooling, and is loved by millions.
89+
90+
## Quickstart
91+
92+
[Get started in 5 minutes][quickstart].
93+
94+
## Ecosystem
95+
96+
<p>
97+
<img src="/docs/images/angular-ecosystem-logos.png" alt="angular ecosystem logos" width="500px" height="auto">
98+
</p>
99+
100+
- [Angular Framework][aio]
101+
- [Angular Material][angularmaterial]
102+
103+
## Changelog
104+
105+
[Learn about the latest improvements][changelog].
106+
107+
## Upgrading
108+
109+
Check out our [upgrade guide](https://update.angular.io/) to find out the best way to upgrade your project.
110+
111+
## Contributing
112+
113+
### Contributing Guidelines
114+
115+
Read through our [contributing guidelines][contributing] to learn about our submission process, coding rules and more.
116+
117+
### Want to Help?
118+
119+
Want to report a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for [contributing][contributing] and then check out one of our issues labeled as <kbd>[help wanted](https://github.com/angular/angular-cli/labels/help%20wanted)</kbd> or <kbd>[good first issue](https://github.com/angular/angular-cli/labels/good%20first%20issue)</kbd>.
120+
121+
### Code of Conduct
122+
123+
Help us keep Angular open and inclusive. Please read and follow our [Code of Conduct][codeofconduct].
124+
125+
### Developer Guide
126+
127+
Read through our [developer guide][developer] to learn about how to build and test the Angular CLI locally.
128+
129+
130+
## Community
131+
132+
Join the conversation and help the community.
133+
134+
- [Twitter][twitter]
135+
- [Discord][discord]
136+
- [Gitter][gitter]
137+
- [YouTube][youtube]
138+
- [StackOverflow][stackoverflow]
139+
- Find a Local [Meetup][meetup]
140+
141+
## Packages
45142

46143
This is a monorepo which contains many tools and packages:
47144

48145

49146

50-
## Tools
147+
### Tools
51148

52149
| Project | Package | Version | Links |
53150
|---|---|---|---|
@@ -56,7 +153,7 @@ This is a monorepo which contains many tools and packages:
56153
**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)
57154

58155

59-
## Packages
156+
### Packages
60157

61158

62159
| Project | Package | Version | Links |
@@ -81,3 +178,26 @@ This is a monorepo which contains many tools and packages:
81178
**Webpack Angular Plugin** | [`@ngtools/webpack`](https://npmjs.com/package/@ngtools/webpack) | [![latest](https://img.shields.io/npm/v/%40ngtools%2Fwebpack/latest.svg)](https://npmjs.com/package/@ngtools/webpack) | [![snapshot](https://img.shields.io/badge/snapshot--blue.svg)](https://github.com/angular/ngtools-webpack-builds)
82179

83180

181+
182+
**Love Angular CLI? Give our repo a star :star: :arrow_up:.**
183+
184+
[contributing]: CONTRIBUTING.md
185+
[developer]: docs/DEVELOPER.md
186+
[quickstart]: https://angular.io/start
187+
[changelog]: CHANGELOG.md
188+
[documentation]: https://angular.io/docs
189+
[angularmaterial]: https://material.angular.io/
190+
[cli]: https://cli.angular.io/
191+
[aio]: https://angular.io/
192+
[workspaceconfig]: https://angular.io/guide/workspace-config
193+
[schematics]: https://angular.io/guide/schematics
194+
[filestructure]: https://angular.io/guide/file-structure
195+
[node.js]: https://nodejs.org/
196+
[npm]: https://www.npmjs.com/get-npm
197+
[codeofconduct]: https://github.com/angular/angular/blob/master/CODE_OF_CONDUCT.md
198+
[twitter]: https://www.twitter.com/angular
199+
[discord]: https://discord.gg/angular
200+
[gitter]: https://gitter.im/angular/angular-cli
201+
[stackoverflow]: https://stackoverflow.com/questions/tagged/angular-cli
202+
[youtube]: https://youtube.com/angular
203+
[meetup]: https://www.meetup.com/find/?keywords=angular

‎docs/images/angular-cli-logo.png‎

2.35 KB
Loading

‎docs/images/angular-ecosystem-logos.png‎

196 KB
Loading

0 commit comments

Comments
 (0)