Skip to content

Commit 25efc6a

Browse files
committed
README: change CI platform language
I realized that this section of the README was sounding like an invitation for potential starter projects, without giving people full context on what the "maintain" part of maintaining a tier-one platform would involve (long term commitment from an experienced engineer). In practice, macOS seems to be the main "other" platform that folks are interested in, but it's also the only one that those of us without Apple hardware can't test locally -- every other OS permits virtualization, which makes macOS a uniquely high support burden. To avoid misleading people, I've adjusted the language to remove the suggestion that we're looking for maintainers. It's not that we _aren't_ looking for maintainers, but more that maintaining a platform will be a longer discussion and not merely a PR.
1 parent d6fc5ab commit 25efc6a

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.mkdn

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,12 @@ The repo is laid out as follows.
5757

5858
# Developing
5959

60-
We currently support Linux and Windows as first-tier platforms. macOS is also
61-
used on a daily basis by Oxide employees, but is not tested in CI. The build
62-
probably also works on Illumos; if anyone would like to step up to maintain
63-
support and a continuous build for Illumos or macOS, we'd love the help.
60+
We currently support Linux and Windows as first-tier platforms. Because of some
61+
inconsistency in linker behavior across platforms, images may not match across
62+
platforms, so we recommend choosing one as your "official" build platform for
63+
producing blessed images. macOS and Illumos are both used as informal build
64+
platforms by Oxide employees, though they are not currently tested in CI. (Oxide
65+
blessed images are produced on Linux.)
6466

6567
To submit changes for review, push them to a branch in a fork and submit a pull
6668
request to merge that branch into `master`. For details, see

0 commit comments

Comments
 (0)