Skip to content

Commit 88553d4

Browse files
DevExtreme Schematics: Update Readme
1 parent c17f584 commit 88553d4

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

packages/devextreme-schematics/README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# DevExtreme Schematics
2-
DevExtreme schematics are workflow tools you can use in an Angular application created with [DevExtreme CLI](https://github.com/devexpress/DevExtreme-CLI) to add DevExtreme libraries or views and perform other DevExtreme-related tasks. Read [this article](https://blog.angular.io/schematics-an-introduction-dc1dfbc2a2b2) for more information on Angular Schematics.
2+
DevExtreme Schematics contains Angular workflow tools for applications created with [DevExtreme CLI](https://github.com/devexpress/DevExtreme-CLI). You can use these tools to add application views and layouts to your app, as well as to perform other tasks related to DevExtreme and the DevExtreme [Angular Application Template](https://devexpress.github.io/devextreme-angular-template). For more information on Angular Schematics, refer to the following topic: [Introduction to Angular Schematics](https://blog.angular.io/schematics-an-introduction-dc1dfbc2a2b2).
33

44
## Included Schematics
55

66
This package includes the following schematics:
77

88
- [install](src/install)
9-
Adds DevExtreme to an Angular application
9+
Adds DevExtreme to an Angular application.
1010

1111
- [add-layout](src/add-layout)
12-
Adds a DevExtreme layout to a DevExtreme Angular application
12+
Adds a DevExtreme layout to an Angular application.
1313

1414
- [add-app-template](src/add-app-template)
15-
Adds a DevExtreme layout template to an Angular application
15+
Adds a DevExtreme app template to an Angular application.
1616

1717
- [add-sample-views](src/add-sample-views)
18-
Adds sample views to a DevExtreme Angular application
18+
Adds sample views to an Angular application
1919

2020
- [add-view](src/add-view)
21-
Adds a view to a DevExtreme Angular application
21+
Adds a view to an Angular application
2222

2323
## TypeScript Dependency & Global CLI Usage
2424

@@ -28,20 +28,21 @@ Some DevExtreme migration schematics require TypeScript to process inline Angula
2828
- Your project's node_modules
2929
- The global node_modules
3030

31-
If TypeScript is not found, inline template migration will be skipped and a warning will be shown with resolution attempts and errors.
31+
If the CLI fails to find TypeScript, inline template migration is skipped and a warning is displayed with resolution attempts and errors.
3232

33-
### How to Fix TypeScript Not Available
33+
### How to Install TypeScript
3434

35-
1. **Local Project:** Install TypeScript in your project root:
35+
1. **Local Project:** To install TypeScript in a project, run the following command:
3636
```sh
3737
npm install typescript --save-dev
3838
```
39-
2. **Global CLI:** If you use the CLI globally, also install TypeScript globally:
39+
2. **Global CLI:** To install TypeScript globally on your machine, run the following command:
4040
```sh
4141
npm install -g typescript
4242
```
43-
3. **npx Usage:** If you use npx, ensure TypeScript is available in your workspace or globally.
44-
4. **Troubleshooting:**
43+
44+
**Troubleshooting**
45+
4546
- Some npm global installs may not link dependencies as expected. If you see repeated TypeScript resolution errors, try running the CLI from a project where TypeScript is installed locally.
4647
- You can also manually link TypeScript to your global node_modules if needed.
4748

0 commit comments

Comments
 (0)