From 0f5490a0042e21271f99ba3cc31e9ec09438cd66 Mon Sep 17 00:00:00 2001 From: Johann Fischer Date: Tue, 20 Jul 2021 17:44:21 +0200 Subject: [PATCH] samples: usb: console: convert README to RST file Convert README to RST file. Signed-off-by: Johann Fischer --- samples/subsys/usb/console/README.rst | 44 +++++++++++++++++++++++++++ samples/subsys/usb/console/README.txt | 29 ------------------ 2 files changed, 44 insertions(+), 29 deletions(-) create mode 100644 samples/subsys/usb/console/README.rst delete mode 100644 samples/subsys/usb/console/README.txt diff --git a/samples/subsys/usb/console/README.rst b/samples/subsys/usb/console/README.rst new file mode 100644 index 00000000000..08f05aca7d2 --- /dev/null +++ b/samples/subsys/usb/console/README.rst @@ -0,0 +1,44 @@ +.. _cdc-acm-console: + +Console over CDC ACM UART Sample +################################ + +Overview +******** + +A simple Hello World sample, with console output coming via CDC ACM UART. +Primarily intended to show the required config options. + +Requirements +************ + +This project requires a USB device controller driver. + +Building and Running +******************** + +This sample can be built for multiple boards, in this example we will build it +for the reel_board board: + +.. zephyr-app-commands:: + :zephyr-app: samples/subsys/usb/console + :board: reel_board + :goals: flash + :compact: + +Plug the board into a host device, for sample, a PC running Linux OS. +The board will be detected as a CDC_ACM serial device. To see the console output +from the sample, use a command similar to "minicom -D /dev/ttyACM0". + +.. code-block:: console + + Hello World! arm + Hello World! arm + Hello World! arm + Hello World! arm + +Troubleshooting +=============== + +You may need to stop modemmanager via "sudo stop modemmanager", if it is +trying to access the device in the background. diff --git a/samples/subsys/usb/console/README.txt b/samples/subsys/usb/console/README.txt deleted file mode 100644 index 7e477c5c370..00000000000 --- a/samples/subsys/usb/console/README.txt +++ /dev/null @@ -1,29 +0,0 @@ -Title: USB Console Hello World - -Description: - -A simple Hello World example, with console output coming to USB UART. Primarily -intended to show the required config options. - -Usage ------ -Plug the board into a host device, for example, a PC running Linux. -The board will be detected as a CDC_ACM serial device. To see the console output -from the zephyr board, use a command similar to "minicom -D /dev/ttyACM0". -You may need to stop modemmanager via "sudo stop modemmanager", if it is -trying to access the device in the background. - --------------------------------------------------------------------------------- - -Building and Running Project: - -$ west build -b reel_board - -Sample Output: - -Hello World! x86 -Hello World! x86 -Hello World! x86 -Hello World! x86 -... -...