aboutsummaryrefslogtreecommitdiff
path: root/infra/corenix/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'infra/corenix/README.md')
-rw-r--r--infra/corenix/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/infra/corenix/README.md b/infra/corenix/README.md
new file mode 100644
index 000000000000..5a70e2b7ce9b
--- /dev/null
+++ b/infra/corenix/README.md
@@ -0,0 +1,20 @@
+## corenix
+
+#### *Configure and build coreboot using the Nix package manager*
+
+*How to use:*
+
+1. Create a configuration file for your device in `configs/`
+2. Add an entry to flake.nix, i.e. `my-device = makeDevice ./configs/my-device.nix;`
+3. Build the coreboot rom: `nix build -A pkgs.my-device`
+
+*Features*
+
+- Specify the build parameters with NixOS-style modules
+- Share declarative configuration across devices
+- Use cached coreboot and payload builds for different device/payload combinations
+- Use GRUB2, TianoCore or SeaBIOS as primary payload
+
+*Limitations*
+
+- currently only `x86_64-linux` host and target systems are supported