From 32f723499e980c0c50b09584ecdd733dcb3521dd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Milan=20P=C3=A4ssler?= <milan@petabyte.dev>
Date: Sun, 11 Oct 2020 16:00:48 +0200
Subject: improve readme

---
 README.md | 19 ++++++++++++++-----
 1 file changed, 14 insertions(+), 5 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 19949e60462d..9de9b9f5f805 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,18 @@
-Features:
+## corenix
 
-- Specify config overrides as Nix attribute set
-- Change payload without rebuilding coreboot
+*How to use:*
 
-Limitations:
+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 .#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
+
+*Limitations*
 
 - currently only `x86_64-linux` host and target systems are supported
-- It's not yet possible to build with a SeaBIOS payload
+- Only GRUB2 and TianoCore payloads are supported for now
-- 
cgit v1.2.3