Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
Signed-off-by: gbionescu <[email protected]>
  • Loading branch information
gbionescu committed Sep 4, 2024
1 parent c0b1d33 commit c7f8ca4
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,31 @@ For example, to generate an `Ubuntu 21.04` rootfs, run:
./build-rootfs.sh ubuntu21.04
```

Note: By default, all images are generated as sparse files.
Notes:

- All images have ssh enabled by default.
- The default user is `root` with password `root`.
- By default, all images are generated as sparse files.

## Building an initrd

The initrd is built using `./build-initrd.sh`. By default it's based on the alpine image.

## Run with QEMU

To run the generated rootfs with QEMU, run:

```bash
./run-qemu.sh rootfs.ext4
```

This will start a QEMU instance with the rootfs with the following options:
- no KVM, network, or graphics
- 1GB of RAM
- 1 CPU (default)
- serial console in the terminal
- uses a kernel image that is [built-in to the repo](kernel/README.md)

## Customizing the build process

Each rootfs generator consists of 3 files:
Expand Down

0 comments on commit c7f8ca4

Please sign in to comment.