about summary refs log tree commit diff
path: root/modules/nixos-apple-silicon/README.md
blob: 2a3eac8d9c4df4e2dfcf46ca0c5a42da8ebafded (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
## About

This repository contains package expressions and NixOS configuration modules which are intended to provide a useful and straightforward bare metal NixOS experience on Apple Silicon Macs. Once NixOS is installed and the Apple Silicon configuration module is added, the system can be configured and operated like any other NixOS system.

We aim to generally replicate the experience and software configuration/versions provided by the Asahi Linux reference distro, and we rely primarily on their hard work. Contributions to improve the NixOS experience and address specific issues are welcome, but configuration and versions which diverge significantly will not be accepted.

Please see the documentation and guide below to get started.

## Documentation

* [Release Notes](docs/release-notes.md)
* [Setup, Installation, and Maintenance Guide (2024-03-24)](docs/uefi-standalone.md)

## Credits

This is mostly a restructuring of work many others have already done, and it wouldn't have been possible without them. Important parts of the NixOS on Apple Silicon experience include (but are not limited to):
* [Asahi Linux's m1n1 bootloader/hypervisor](https://github.com/AsahiLinux/m1n1)
* [Asahi Linux's kernel patches](https://github.com/AsahiLinux/linux)
* [Mark Kettenis' U-boot port](https://github.com/kettenis/u-boot)
* [Alyssa Rosenzweig's Mesa GPU driver](https://gitlab.freedesktop.org/asahi/mesa)

The Nix derivations and documentation in this repository are licensed under the MIT license as included in the [LICENSE](LICENSE) file. Patches included in this repository, and the files that Nix builds, are covered by separate licenses.