Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shengwen-tw committed Jul 24, 2023
1 parent e6c7cac commit efda0c1
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ A minimalist RISC-V system emulator capable of running Linux the kernel and corr
- UART: 8250/16550
- PLIC (platform-level interrupt controller): 32 interrupts, no priority
- Standard SBI, with the timer extension
- VirtIO: virtio-net, mapped as TAP interface
- VirtIO: virtio-blk acquires disk image from the host, and virtio-net is mapped as TAP interface

## Prerequisites

Expand Down Expand Up @@ -62,6 +62,16 @@ Please note that it only supports the Linux host environment.
$ make build-image
```

## Usage

```
./semu -k linux-image [-b dtb-file] [-d disk-image]
```

* `linux-image` is the path to the Linux kernel `Image`.
* `dtb-file` is optional, as it specifies the user-specified device tree blob.
* `disk-image` is optional, as it specifies the path of a disk image in ext4 file system for the virtio-blk device.

## License

`semu` is released under the MIT License.
Expand Down

0 comments on commit efda0c1

Please sign in to comment.