tidy up examples and CI

dronecan · Aug 31, 2023 · 5a2a36b · 5a2a36b
1 parent bfbc54e
commit 5a2a36b
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 5 deletions.
diff --git 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
@@ -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")