Skip to content

Commit 695d87d

Browse files
committed
chore: improve readme
1 parent 9bebc81 commit 695d87d

1 file changed

Lines changed: 9 additions & 10 deletions

File tree

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,14 @@
44

55
- Windows with TcXaeShell Version 15.0 or higher
66

7-
## 2 Installation and Usage
7+
## 2 Installation
88

99
To install the complete framework, you need to install three components:
1010

1111
1. VS Code extension: `BCS Engineering DSL`
1212
2. `bcs-engineering-cli` - The CLI to generate the artifacts from the DSL files.
1313
3. `TcAutomation` - The tool to create and deploy the TwinCAT project from the generated artifacts.
1414

15-
After the installation you can have a look at the [example](language/example) folder to see how to use the framework.
16-
1715
### 2.1 Install bcs-engineering-cli and VS Code Extension
1816

1917
To install the `bcs-engineering-cli` and `BCS Engineering DSL` VS Code extension, follow the installation and usage instructions in the [README](language/README.md) file.
@@ -23,28 +21,29 @@ To install the `bcs-engineering-cli` and `BCS Engineering DSL` VS Code extension
2321
_TcAutomation_ is responsible for the creation and deployment of the corresponding TwinCAT project given the generated artifacts. To install it, you need to run the `TcAutomationInstaller.exe`.
2422
To create the installer, follow the steps described in the [TcAutomation](TcAutomation/README.md) README file.
2523

26-
### 2.3 Check TcAutomation Installation
24+
#### Check TcAutomation Installation
2725

2826
To check if _TcAutomation_ is installed correctly, you can run the following command in a command:
2927

3028
```bash
3129
TcAutomation --help
3230
```
3331

34-
### 2.5 BCS Engineering CLI
32+
## 3 Usage
33+
34+
After installation, explore the [example](language/example) folder to get started with the framework. The examples demonstrate how to define control logic and hardware configurations using the BCS Engineering DSL. You can either generate some of the artifacts (ST and TwinCAT config files) without deployment or generate and deploy them to a Beckhoff device.
3535

36-
#### 2.5.1 Generate
36+
#### 3.1 Generate
3737

38-
To generate the artifacts, you can run the following command in the `language/example` folder:
38+
To generate the artifacts, you can run the following command in the `language/example` directory:
3939

4040
```bash
4141
bcs-engineering-cli beckhoff generate .\kBus\control.bcsctrl
4242
```
4343

44-
#### 2.5.2 Deploy
44+
#### 3.2 Deploy
4545

46-
To deploy the generated artifacts, you can run the following command in the `language/example` folder.
47-
(Note: this command generates and deploys the artifacts)
46+
To generate and deploy the artifacts, you can run the following command in the `language/example` directory:
4847

4948
```bash
5049
bcs-engineering-cli beckhoff deploy .\kBus\control.bcsctrl

0 commit comments

Comments
 (0)