diff --git a/README.md b/README.md index f798cbe..d3e6059 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ -[![Build Status](https://dev.azure.com/kopernikusauto/AVP/_apis/build/status/open-source/ecal-rs%20release?branchName=main)](https://dev.azure.com/kopernikusauto/AVP/_build/latest?definitionId=3&branchName=main) -[![Build and Test](https://github.com/kopernikusauto/ecal-rs/actions/workflows/build.yml/badge.svg)](https://github.com/kopernikusauto/ecal-rs/actions/workflows/build.yml) +# ecal-rs +[![Build and Test](https://github.com/kopernikusauto/ecal-rs/actions/workflows/check.yml/badge.svg)](https://github.com/kopernikusauto/ecal-rs/actions/workflows/check.yml) -# ecal-rs -Rust bindings to the Continental eCAL API +Rust bindings to the Continental eCAL API. + +A build environment is defined in the [devcontainer.json](.devcontainer/devcontainer.json) file, and can be loaded in VS Code (docs describing that process are [here](https://code.visualstudio.com/docs/devcontainers/containers)). diff --git a/demo/README.md b/demo/README.md new file mode 100644 index 0000000..df122ba --- /dev/null +++ b/demo/README.md @@ -0,0 +1,21 @@ +# Demo + +A simple demo in which two agents communicate with each other. + +To test it, run the demo twice (in two windows) at the same time: + + # `ping` running in window 1: + $ RUST_LOG=info cargo run --release + [2023-04-04T09:32:48Z INFO ecal] eCAL initiailized as 'kcal_ping'. + [2023-04-04T09:32:49Z INFO ecal_ping_demo] Ping 1 + [2023-04-04T09:32:49Z INFO ecal_ping_demo] Pong 2 + [2023-04-04T09:32:50Z INFO ecal_ping_demo] Ping 2 + [2023-04-04T09:32:50Z INFO ecal_ping_demo] Pong 3 + + # `pong` running simultaneously in window 2: + $ RUST_LOG=info cargo run --release -- --pong + [2023-04-04T09:32:48Z INFO ecal] eCAL initiailized as 'kcal_ping'. + [2023-04-04T09:32:48Z INFO ecal_ping_demo] Ping 1 + [2023-04-04T09:32:49Z INFO ecal_ping_demo] Ping 1 + [2023-04-04T09:32:49Z INFO ecal_ping_demo] Ping 1 + [2023-04-04T09:32:49Z INFO ecal_ping_demo] Pong 2