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 `.img.dbg`. + +To generate such an image, run `python3 package.py out/kernel ... output/path/memory.img`. You can edit the script to change various variables. They somewhat well documented. \ No newline at end of file