Skip to content

Commit 789e09b

Browse files
authored
Issue #443 - Add notes to documentation explaining what architectures are supported
1 parent e1c257b commit 789e09b

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -282,19 +282,19 @@ It is anyway mandatory to extend the container image to install the specific dat
282282

283283
### Supported devices and architectures
284284

285-
As mentioned on the [Docker Hub](https://hub.docker.com/r/ppodgorsek/robot-framework), the project has been built and uploaded as a `linux/amd64` image. This means ARM devices won't be able to run the image with the default configuration.
285+
As mentioned on the [Docker Hub](https://hub.docker.com/r/ppodgorsek/robot-framework), the project has been built and uploaded as a `linux/amd64` image only. This means ARM devices such as MacBook M1/M2 and Amazon EC2 Graviton won't be able to run the image with the default configuration.
286286

287-
Podman and Docker provide a `--platform` option which emulates a given application architecture, such as:
287+
As mentioned in the official documentation, [Podman](https://docs.podman.io/en/latest/markdown/podman-run.1.html#platform-os-arch) and [Docker](https://docs.docker.com/build/building/multi-platform/) provide a `--platform` option which selects a given application architecture, such as:
288288

289289
docker run \
290290
--platform linux/amd64 \
291291
-v <local path to the reports' folder>:/opt/robotframework/reports:Z \
292292
-v <local path to the test suites' folder>:/opt/robotframework/tests:Z \
293293
ppodgorsek/robot-framework:<version>
294294

295-
Please note: such emulation might not work, depending on your device and operating system.
295+
Please note: builds and automated tests of this project will remain performed on a `linux/amd64` architecture so such emulation might not work, depending on your device and operating system.
296296

297-
If this does not solve your platform-related issues, you will have to rebuild the image for your device/platform.
297+
If this does not solve your platform-related issues, you will have to rebuild the image for your device/platform, specifying that `--platform` option during the build and run.
298298

299299
## Please contribute!
300300

0 commit comments

Comments
 (0)