Skip to content

Getting Started

This section is for people who want to work on Aurora Silicon itself. If you only want to run Windows on a Mac, the user guide is the place to start.

Draft

This page is an outline. The sections below describe what still needs to be written, and no technical detail here should be treated as accurate yet.

What you'll need

To write: the hardware and host setup expected of a contributor — which Mac to develop against, what to develop from, and whether a second machine is required for tethered work. Say plainly which parts are optional.

The repositories

To write: the map of our repositories and what each one is for — the bootloader tree, the kernel tree, the installer, and the per-platform bring-up trees. This is the page's most useful section for a newcomer, because the split between them is not obvious from the outside.

Getting the source

To write: how to clone what you need, including submodules, and which branch to start from. Note anything that must sit on a case-sensitive filesystem.

Your first build

To write: the shortest path from a fresh clone to a build that produces something, so a new contributor gets a working result before learning the rest.

Getting a machine ready to test on

To write: what has to be true of a Mac before you can load your own build onto it, and how to recover it when a build does not boot. Link to feature support so people can check what state their hardware is in.

Where to ask

To write: which channel to use for development questions, and what to include when asking about a failure.

Next steps

Once you can build, see Development/Tooling for the toolchain in detail, Testing for how results are recorded, and Contributing before you send anything back.