From 9ec7e60cb6db04c6a47975d16f05c2b9a3c19852 Mon Sep 17 00:00:00 2001 From: Dave Rolsky Date: Sat, 21 Dec 2024 11:42:51 -0600 Subject: [PATCH] Clarify use cases in `README.md` --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3cc1d87..a8f638c 100644 --- a/README.md +++ b/README.md @@ -58,9 +58,12 @@ jobs: target: ${{ matrix.platform.target }} ``` -Note that for Linux or BSD targets, you should always set the `runs-on` key to an x86-64 -architecture runner. If you want to do native ARM compilation, for example using -`ubuntu-latest-arm`, then there's no point in using this action. This action is only tested on +Note that for Linux or BSD targets, you should always set the `runs-on` key to a Linux x86-64 +architecture runner. + +If you _only_ want to do native ARM compilation, for example using the `ubuntu-latest-arm` runner, +then there's no need to use this action. However, if you want to compile for _many_ platforms, +including Linux ARM, using this action will simplify your config. This action is only tested on Ubuntu x86-64, Windows, and macOS runners. ## Input Parameters