From 75832c8135a5130b761e011e75f1263bea660f23 Mon Sep 17 00:00:00 2001 From: Andrew Tridgell Date: Fri, 1 Sep 2023 09:27:18 +1000 Subject: [PATCH] tidy up examples and CI --- .github/workflows/examples.yml | 3 --- examples/README.md | 14 ++++++++++++-- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml index 12312fe..03af65f 100644 --- a/.github/workflows/examples.yml +++ b/.github/workflows/examples.yml @@ -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 diff --git a/examples/README.md b/examples/README.md index 4f68175..ae9807c 100644 --- a/examples/README.md +++ b/examples/README.md @@ -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")