Skip to content

Commit 4aa01ed

Browse files
authored
Merge pull request #10 from prdktntwcklr/style/add-test-img
style: add image for successful test to readme
2 parents a5a90af + b3f84c8 commit 4aa01ed

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# Renode Example
22

3-
Simple example on how to use [Renode](https://renode.io/) together with
3+
Simple example of how to use [Renode](https://renode.io/) together with
44
[Robot Framework](https://robotframework.org/) to emulate and test Firmware
55
on a host PC without the target hardware.
66

77
The project builds for an STM32
88
[NUCLEO-F446RE development board](https://www.st.com/en/evaluation-tools/nucleo-f446re.html).
99
The default repl (REnode PLatform) file for this board has been modified to
10-
include the blue button functionality. Pressing and then releasing this button
11-
toggles one of the on-board LED.
10+
include the blue button functionality. Pressing and releasing this button
11+
toggles one of the on-board LEDs.
1212

1313
## Toolchain
1414

1515
- Arm GNU Toolchain 12.2
1616
- GNU Make 4.3
1717
- Renode 1.14.0
18-
- STM32CubeMX 6.8.1 (*project setup only*)
18+
- STM32CubeMX 6.8.1 (*for initial project setup only*)
1919

2020
## Building the project
2121

@@ -28,13 +28,17 @@ make
2828
```
2929

3030
This should create the compiled binaries under the
31-
`nucleo-f446re/ButtonLed/build` directory, which are then used in the next step.
31+
`nucleo-f446re/ButtonLed/build` directory.
3232

3333
## Testing with Renode
3434

35-
After building successfully, run the following command from the main directory
35+
After building the binaries, run the following command from the main directory
3636
to test for the expected behavior:
3737

3838
```bash
3939
renode-test tests/test-button.robot
4040
```
41+
42+
Sample output from GitHub Actions after a successful test:
43+
44+
![test_success](docs/test_success.png)

docs/test_success.png

36.8 KB
Loading

0 commit comments

Comments
 (0)