Skip to content

Commit

Permalink
tidy up examples and CI
Browse files Browse the repository at this point in the history
  • Loading branch information
tridge committed Sep 1, 2023
1 parent 3a6a603 commit 75832c8
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
3 changes: 0 additions & 3 deletions .github/workflows/examples.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,3 @@ jobs:
- name: build ESCNode C++
working-directory: ${{github.workspace}}/examples/ESCNode_C++
run: make
- name: build ESCNode UDP
working-directory: ${{github.workspace}}/examples/ESCNode_UDP
run: make
14 changes: 12 additions & 2 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,18 @@ You may need to install the following before building:

## Running Examples

Before you run the examples you need to start socketcan on Linux. See
the setup_socketcan.sh script in this directory for starting socketcan
The examples can use either socketcan or multicast UDP as the
transport on Linux.

To run with multicast UDP you can start like this:

```
./esc_node mcast:0
```

If you want to use socketcan then you need to start socketcan on
Linux. See the setup_socketcan.sh script in this directory for
starting socketcan

![setup_socketcan.sh](setup_socketcan.jpg "setup_socketcan.sh")

Expand Down

0 comments on commit 75832c8

Please sign in to comment.