Merge pull request #11 from prdktntwcklr/ci/add-devcontainer

ci: add devcontainer

Author: prdktntwcklr

.devcontainer/devcontainer.json

@@ -0,0 +1,22 @@
+{
+    "name": "Renode Example",
+    "dockerFile": "../Dockerfile",
+    "runArgs": [
+        "--security-opt",
+        "label=disable"
+    ],
+    "containerEnv": {
+        "WORKSPACE_DIR": "${containerWorkspaceFolder}",
+        "PROMPT_COMMAND": "history -a"
+    },
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "ms-vscode.cpptools"
+            ],
+            "settings": {
+                "terminal.integrated.defaultProfile.linux": "bash"
+            }
+        }
+    }
+}

README.md

@@ -1,26 +1,28 @@
 # Renode Example
 
 Simple example of how to use [Renode](https://renode.io/) together with
-[Robot Framework](https://robotframework.org/) to emulate and test Firmware
+[Robot Framework](https://robotframework.org/) to emulate and test firmware
 on a host PC without the target hardware.
 
 The project builds for an STM32
 [NUCLEO-F446RE development board](https://www.st.com/en/evaluation-tools/nucleo-f446re.html).
-The default repl (REnode PLatform) file for this board has been modified to
-include the blue button functionality. Pressing and releasing this button
+The default repl (`REnode PLatform`) file for this board has been modified to
+include the blue user button functionality. Pressing and releasing this button
 toggles one of the on-board LEDs.
 
 ## Toolchain
 
-- Arm GNU Toolchain 12.2
-- GNU Make 4.3
+- GNU Arm Embedded Toolchain 10-2020-q4-major
+- GNU Make 4.2.1
 - Renode 1.14.0
 - STM32CubeMX 6.8.1 (*for initial project setup only*)
 
 ## Building the project
 
 After installing the required packages on your machine (consider using the
-provided `Dockerfile`), you can build the project by running:
+provided `Dockerfile` together with the
+[Dev Containers extension](https://code.visualstudio.com/docs/devcontainers/containers)
+for VS Code), you can build the project by running:
 
 ```bash
 cd nucleo-f446re/ButtonLed
@@ -39,6 +41,6 @@ to test for the expected behavior:
 renode-test tests/test-button.robot
 ```
 
-Sample output from GitHub Actions after a successful test:
+Sample output from GitHub Actions after the test has run successfully:
 
 ![test_success](docs/test_success.png)