Skip to content

Commit

Permalink
Merge pull request #34 from simatic-ax/fix-update_readme
Browse files Browse the repository at this point in the history
Fix update readme
  • Loading branch information
sjuergen authored Jul 16, 2024
2 parents 408930e + 966415d commit 7757b2f
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 3 deletions.
1 change: 1 addition & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [

{
"name": "Debug live on PLC",
"type": "plc-debug",
Expand Down
15 changes: 13 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ This application example shows how to use the state framework of the package `@s
```sh
cd ae-trafficlight
```

install the dependencies with:

```sh
apax install
```

and open AxCode

```sh
axcode .
```
Expand All @@ -59,6 +59,8 @@ This application example shows how to use the state framework of the package `@s
1. Go online
![traffic light](./doc/trafficlight.gif)
## Tips and tricks
### Change the IP address for the downloader
Expand All @@ -73,6 +75,15 @@ To change the IP address for the debugging, open the file `./vscode/launch.json`
Thanks for your interest in contributing. Anybody is free to report bugs, unclear documentation, and other problems regarding this repository in the Issues section or, even better, is free to propose any changes to this repository using Merge Requests.
### Markdownlint-cli
This workspace will be checked by the [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) (there is also documented ho to install the tool) tool in the CI workflow automatically.
To avoid, that the CI workflow fails because of the markdown linter, you can check all markdown files locally by running the markdownlint with:
```sh
markdownlint **/*.md --fix
```
## License and Legal information
Please read the [Legal information](LICENSE.md)
1 change: 0 additions & 1 deletion apax-files-section.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
files:
- template
- '!**/.git'
- '!**/.vscode'
- '!**/.github'
- '!**/.gitattributes'
- '!**/.markdownlint.yml'
Expand Down
Binary file added doc/trafficlight.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7757b2f

Please sign in to comment.