Skip to content

Commit

Permalink
fix markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
sjuergen committed Feb 9, 2024
1 parent fd2cf3f commit ba43e2b
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 7 deletions.
14 changes: 14 additions & 0 deletions .markdownlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# markdownlint YAML configuration
---

# Default state for all rules
default: true

# ignored rules
line-length: false
no-inline-html: false
first-line-h1: false
no-emphasis-as-header: false
MD024:
allow_different_nesting: true
siblings_only: true
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
# Hello AX World

This is a simple PLC application which can be downloaded to a PLC **or** some unit tests can be executed.
This is a simple PLC application which can be downloaded to a PLC **or** some unit tests can be executed.

> For downloading to a PLC it is additional effort necessary and it is depending on Local IDE or Web IDE.
The `Hello AX World` contains:
- A small program which can be downloaded to the PLC
- This contains a ST configuration, a ST program and a function which returns a string `Hello AX World`
- A unit test, which check the return value of the function.
- A watchtable to monitor the variable which contains the

- A small program which can be downloaded to the PLC
- This contains a ST configuration, a ST program and a function which returns a string `Hello AX World`
- A unit test, which check the return value of the function.
- A watchtable to monitor the variable which contains the

## Install project

Clone link for cloning the repository

```
```sh
[email protected]:simatic-ax/hello-ax-world.git
```

Expand All @@ -24,4 +25,4 @@ Thanks for your interest in contributing. Anybody is free to report bugs, unclea

## License and Legal information

Please read the [Legal information](LICENSE.md)
Please read the [Legal information](LICENSE.md)

0 comments on commit ba43e2b

Please sign in to comment.