From 4e7a6a20f9e0114d2353ca39c58958105e06994c Mon Sep 17 00:00:00 2001
From: Anton Lydike <me@antonlydike.de>
Date: Sat, 21 Aug 2021 21:27:11 +0200
Subject: [PATCH] updated readme

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

diff --git a/README.md b/README.md
index a9bd9de..644574a 100644
--- a/README.md
+++ b/README.md
@@ -12,3 +12,12 @@ I am using the [riscv-gnu-toolchain](https://github.com/riscv/riscv-gnu-toolchai
 ## The Makefile:
 
 You can build the kernel using `make kernel`. Make sure the toolchain is in your path!
+
+
+## Packaging a kernel image with user programs
+
+You can use the `package.py` script to package a kernel and multiple user binaries into a single `img` file.
+
+Debugging information is also emitted, it's a json formatted file called `<name>.img.dbg`.
+
+To generate such an image, run `python3 package.py out/kernel <user bin 1> <usr bin 2> ... output/path/memory.img`. You can edit the script to change various variables. They somewhat well documented.
\ No newline at end of file