From 03887788339d33f343b98816fb6091849ddf23d6 Mon Sep 17 00:00:00 2001 From: "Michal Princ (nxa17570)" Date: Thu, 20 Apr 2023 12:59:22 +0200 Subject: [PATCH] Add Examples section into README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 6f03757..a8cdf36 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,18 @@ The user is responsible for destroying any RPMsg-Lite objects he has created in ![RPMsg Lite copy and no-copy interface, multiple scenarios](./doxygen/images/rpmsg_lite_send_receive.png) +## Examples + +RPMsg_Lite multicore examples are part of NXP MCUXpressoSDK packages. Visit [https://mcuxpresso.nxp.com](https://mcuxpresso.nxp.com) to configure, build and download these packages. To get the board list with multicore support (RPMsg_Lite included) use filtering based on Middleware and search for 'multicore' string. Once the selected package with the multicore middleware is downloaded, see + +/boards//multicore_examples for RPMsg_Lite multicore examples with 'rpmsg_lite_' name prefix. + +Another way of getting NXP MCUXpressoSDK RPMsg_Lite multicore examples is using the [mcux-sdk](https://github.com/nxp-mcuxpresso/mcux-sdk) Github repo. Follow the description how to use the West tool to clone and update the mcuxsdk repo in [readme Overview section](https://github.com/nxp-mcuxpresso/mcux-sdk#overview). Once done the armgcc rpmsg_lite examples can be found in + +mcuxsdk/examples//multicore_examples + +You can use the evkmimxrt1170 as the board_name for instance. Similar to MCUXpressoSDK packages the RPMsg_Lite examples use the 'rpmsg_lite_' name prefix. + # Configuration options The RPMsg-Lite can be configured at the compile time. The default configuration is defined in the rpmsg_default_config.h header file. This configuration can be customized by the user by including rpmsg_config.h file with custom settings. The following table summarizes all possible RPMsg-Lite configuration options.