Skip to content

Commit c9a18b0

Browse files
README MD Structure Cleanup
1 parent fed09e6 commit c9a18b0

1 file changed

Lines changed: 30 additions & 10 deletions

File tree

README.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11

2-
OpenKNXproducer
3-
===
2+
# OpenKNXproducer
3+
44
**OpenKNXproducer** is a commandline tool to create knxprod files for ETS.
55

66
It is the successor of [multiply-channels](https://github.com/mumpf/multiply-channels), which will be discontinued. multiply-channels and OpenKNXproducer are compatible, as long as you want to convert simple xml-sources using ETS 5.x. As soon as you use the include-functionality of these tools, there is no compatibility anymore.
77

88
For [OpenKNX_Projects](https://github.com/OpenKNX) or for knxprod-creation with ETS 6 you should use OpenKNXproducer.
99

10-
### Features
10+
11+
## Features and Arguments
12+
1113
The current version provides the following verbs:
1214
- **create** Check given xml file and create knxprod
1315
- **check** Execute sanity checks on given xml file
@@ -16,10 +18,18 @@ The current version provides the following verbs:
1618
- **help** Display more information on a specific command.
1719
- **version** Display version information.
1820

19-
This tool also creates a header file with defines for all parameter and communication object definitions in the XML. **Requirements:** ETS must be installed. Supported versions are: ETS 4, ETS 5.5, ETS 5.6, ETS 5.7 and ETS 6.0. The correct ETS converter version is automatically found dependent on xmlns of provided xml document.
21+
This tool also creates a header file with defines for all parameter and communication object definitions in the XML.
22+
23+
24+
## Requirements:
25+
26+
ETS must be installed. Supported versions are: ETS 4, ETS 5.5, ETS 5.6, ETS 5.7, ETS 6.0 and ETS 6.3. The correct ETS converter version is automatically found dependent on xmlns of provided xml document.
2027
This project uses **.NET 6.0**.
28+
2129
##
22-
### Examples:
30+
31+
## Examples:
32+
2333
- ``OpenKNXproducer new --ProductName=TempSensor --AppNumber=567 Sensor``
2434

2535
Creates initial Sensor.xml, do sanity checks produce Sensor.h, produce Sensor.knxprod
@@ -37,7 +47,9 @@ This project uses **.NET 6.0**.
3747
Reads Sensor.xml, do sanity checks
3848

3949
##
40-
### Tipps:
50+
51+
## Tipps:
52+
4153
If all sanity checks were OK and the knxprod file was created, there might be still problems using this file in ETS. Because the user is editing an xml file, there might be many other problems there, which are not checked by this tool yet.
4254

4355
**As a general hint:**
@@ -47,21 +59,28 @@ If all sanity checks were OK and the knxprod file was created, there might be st
4759
If you find a situation, which is not yet checked but leads to errors in ETS, report a issue and I will add a new check or just create a pull request. Thank you.
4860

4961
##
50-
### Installation
62+
63+
## Installation
5164
This release is compatible with **Linux**, **macOS**, and **Windows 10/11** (x86, x64, Arm).
65+
5266
### 1. Download and Extract the ZIP file
67+
5368
Download the latest release and extract the entire contents of the ZIP file into a directory.
69+
5470
### 2. Run the installation script
55-
### Windows
71+
72+
#### **Windows**
73+
5674
- Right-click on `Install-OpenKNX-Tools.ps1`**Run with PowerShell**.
5775
Confirm any security warnings by selecting **Open File**.
5876
- The tools will be copied to the target directories automatically. Progress will be displayed in the console.
5977
- **Installation Hints**: **Windows: Script Execution Policy**
6078
- If you see "not digitally signed" error: **Solution - then try this:**
6179
- ```PowerShell.exe -ExecutionPolicy Bypass -File .\Install-OpenKNX-Tools.ps1```
6280

63-
### macOS / Linux**
64-
Ensure **PowerShell (pwsh)** is installed: [PowerShell GitHub Releases](https://github.com/PowerShell/powershell/releases)
81+
#### macOS / Linux
82+
83+
- Ensure **PowerShell (pwsh)** is installed: [PowerShell GitHub Releases](https://github.com/PowerShell/powershell/releases)
6584
- ```pwsh ./Install-OpenKNX-Tools.ps1```
6685
- **Installation Hints**:
6786
- **macOS**: Security Block on First Launch* When starting OpenKNXproducer for the first time, macOS may block the app (unidentified developer). Try to start the app → macOS shows a warning.
@@ -70,6 +89,7 @@ Download the latest release and extract the entire contents of the ZIP file into
7089
- Start the app again.
7190

7291
### 3. Remove / Uninstallation
92+
7393
- Use Remove-OpenKNX-Tools.ps1 following similar steps.
7494
- ```pwsh ./Remove-OpenKNX-Tools.ps1```
7595

0 commit comments

Comments
 (0)