From b0a679731f5f9d63b910794a8f3e34b9c4e9a146 Mon Sep 17 00:00:00 2001
From: oliverpool <git@olivier.pfad.fr>
Date: Wed, 23 Mar 2022 11:53:53 +0100
Subject: [PATCH] add README

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index 623e3bf..ded25fc 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,19 @@
 # Kernel for Raspberry Pi 32 bits, for usage in gokrazy
+
+Usage
+
+```
+GOARCH=arm ./gokr-packer \
+		-kernel_package=github.com/oliverpool/kernel-rpi-os-32/dist \
+		-firmware_package=github.com/oliverpool/firmware-rpi/dist \
+		-serial_console=disabled \
+		github.com/gokrazy/hello
+```
+
+## Manual compilation
+
+```
+go run cmd/compile/main.go
+```
+
+It will compile the kernel located in `linux-sources` and copy the resulting files in the `dist` folder.