From 1d0f58069502284eea051a6cff32fb7c04841184 Mon Sep 17 00:00:00 2001 From: Christian Schlotter Date: Fri, 20 Sep 2024 11:45:34 +0200 Subject: [PATCH] docs(examples): fix typos Signed-off-by: Christian Schlotter --- examples/README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/examples/README.md b/examples/README.md index 93369ac..8a433ce 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,13 +1,13 @@ -# Fretish robot examples +# FRETish robot examples This folder contains some examples to demonstrate the use of `fret-to-robot`. ## Preparation You should be familiar with Zephyr and the basic setup as described in the -(Getting Started Guide)[https://docs.zephyrproject.org/latest/develop/getting_started/index.html]. +[Getting Started Guide](https://docs.zephyrproject.org/latest/develop/getting_started/index.html). -For a setup in an example, create a virtual environment, source it, and install `west` (Step 1 - 5) +For a setup in an example, create a virtual environment, source it, and install `west` (Steps 1 to 5) in the Getting Started Guide. Now, also install the `fretish_robot` library. If you are in the current directory, do @@ -24,26 +24,26 @@ west init -l digital_microscope west update ``` -This also fetches a zephyr with (currently custom) `robotframework` harness support for twister, and all -necessary modules +This also fetches a Zephyr with (currently custom) `robotframework` harness support for Twister, and all +necessary modules. ## Creating tests for example -To create robot tests for an example, move into the `assets` folder of the example and call `fret-to-robot` -properly. For example: +To create Robot Framework tests for an example, move into the `assets` folder of the example and call +`fret-to-robot` properly. For example: ```sh fret-to-robot req_fret.json --extra-libraries DigitalMicroscopeLib ``` The `extra-libraries` argument is necessary as we implement keyword functionality in a library -called `DigitalMicroscopeLib` (see `assets/robot_files/DigitalMicroscopeLib.py`) +called `DigitalMicroscopeLib` (see `assets/robot_files/DigitalMicroscopeLib.py`). -Now, the generated files can be found in `assets/robot_files/tests.robot` +Now, the generated files can be found in `assets/robot_files/tests.robot`. ## Execute tests -Now, you can execute the tests with a proper twister execution. +Now, you can execute the tests with a proper Twister execution. To execute all tests for `native_sim_64` platform, do @@ -54,4 +54,4 @@ PYTHONPATH=digital_microscope/assets/robot_files west twister -p native_sim_64 - The setting of `PYTHONPATH` is necessary as we have a custom library for implementation, `-vvv` makes it more verbose to see progress. -Afterwards, the results of the test executions are shown (4 of 15 fail, as `always` FRET keyword is not implemented) +Afterwards, the results of the test executions are shown (4 of 15 fail, as `always` FRET keyword is not implemented).