This repository has been archived by the owner on Jan 27, 2022. It is now read-only.
docs: updating readme #724
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mgechev
reviewed
Apr 28, 2021
README.md
Outdated
| @@ -1,27 +1,73 @@ | |||
| # AngularDevtools | |||
| # Angular Devtools | |||
There was a problem hiding this comment.
Suggested change
| # Angular Devtools | |
| # Angular DevTools |
mgechev
reviewed
Apr 28, 2021
README.md
Outdated
|
|
||
| ## Code scaffolding | ||
| Angular Devtools is a Chrome Developer Tools extension for debugging Angular applications. |
There was a problem hiding this comment.
Suggested change
| Angular Devtools is a Chrome Developer Tools extension for debugging Angular applications. | |
| Angular DevTools is a Chrome DevTools extension for debugging and profiling Angular applications. |
mgechev
reviewed
Apr 28, 2021
README.md
Outdated
|
|
||
| Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`. | ||
| You can install the extension from: [Chrome Store](#) |
There was a problem hiding this comment.
Suggested change
| You can install the extension from: [Chrome Store](#) | |
| You can install the extension from: [Chrome Web Store](#) |
mgechev
reviewed
Apr 28, 2021
README.md
Outdated
|
|
||
| Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build. | ||
| Angular DevTools is a Chrome extension that provides debugging and profiling capabilities for Angular applications. A hard requirement is that the Angular application is running in development mode. If you plan to read the original source code, it is a good idea to generate source maps. Otherwise you will be forced to work with the compiled JavaScript code. |
There was a problem hiding this comment.
I don't think using source maps impacts developers' experience when using Angular DevTools?
mgechev
reviewed
Apr 28, 2021
README.md
Outdated
|
|
||
| Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). | ||
| Angular Devtools supports Angular v9 and above, with Ivy enabled. |
There was a problem hiding this comment.
Suggested change
| Angular Devtools supports Angular v9 and above, with Ivy enabled. | |
| Angular DevTools supports Angular v9 and above, with Ivy enabled. |
mgechev
reviewed
Apr 28, 2021
README.md
Outdated
|
|
||
| ## Running end-to-end tests | ||
| ## Working on Angular Devtools |
There was a problem hiding this comment.
Suggested change
| ## Working on Angular Devtools | |
| ## Working on Angular DevTools |
mgechev
reviewed
Apr 28, 2021
README.md
Outdated
|
|
||
| ## Further help | ||
| To develop the Devtools extension, the following environment is used: |
There was a problem hiding this comment.
I think we can drop this section. People need the Angular CLI, which has node as a pre-requirement. TypeScript is a project dependency, but also is rxjs, we don't need to mention this.
mgechev
reviewed
Apr 28, 2021
README.md
Outdated
|
|
||
| ### Installing and Running locally | ||
|
|
||
| To install and run Devtools locally, perform the following steps: |
There was a problem hiding this comment.
Suggested change
| To install and run Devtools locally, perform the following steps: | |
| To setup your local development environment for Angular DevTools, perform the following steps: |
mgechev
suggested changes
Apr 28, 2021
|
@mgechev updated readme |
mgechev
approved these changes
Apr 30, 2021
AleksanderBodurri
pushed a commit
to AleksanderBodurri/angular-devtools
that referenced
this pull request
Sep 16, 2021
* docs: updating readme * docs: updating readme
AleksanderBodurri
pushed a commit
to AleksanderBodurri/angular-devtools
that referenced
this pull request
Sep 27, 2021
* docs: updating readme * docs: updating readme
AleksanderBodurri
pushed a commit
to AleksanderBodurri/angular-devtools
that referenced
this pull request
Oct 27, 2021
* docs: updating readme * docs: updating readme
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.