Skip to content

Commit 365bdd2

Browse files
committed
Refine top-level documentation
1 parent c2773ea commit 365bdd2

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ usage is the same as the mke2fs command.
3333

3434
For most GNU/Linux distributions, `mkfs.ext4` command should be installed in advance.
3535
For macOS, use the following command:
36-
```
36+
```shell
3737
$ brew install e2fsprogs
3838
```
3939

@@ -66,26 +66,26 @@ Enter `root` to access shell.
6666

6767
You can exit the emulator using: \<Ctrl-a x\>. (press Ctrl+A, leave it, afterwards press X)
6868

69-
## Build Linux kernel image and root file system
70-
71-
An automated build script is provided to compile the RISC-V cross-compiler, Busybox, and Linux kernel from source.
72-
Please note that it only supports the Linux host environment.
73-
74-
```shell
75-
$ make build-image
76-
```
77-
7869
## Usage
7970

80-
```
71+
```shell
8172
./semu -k linux-image [-b dtb-file] [-i initrd-image] [-d disk-image]
8273
```
8374

8475
* `linux-image` is the path to the Linux kernel `Image`.
8576
* `dtb-file` is optional, as it specifies the user-specified device tree blob.
86-
* `initrd-image` is optional, as it specifies the user-specified init RAM disk image.
77+
* `initrd-image` is optional, as it specifies the user-specified initial RAM disk image.
8778
* `disk-image` is optional, as it specifies the path of a disk image in ext4 file system for the virtio-blk device.
8879

80+
## Build Linux kernel image and root file system
81+
82+
An automated build script is provided to compile the RISC-V cross-compiler, Busybox, and Linux kernel from source.
83+
Please note that it only supports the Linux host environment.
84+
85+
```shell
86+
$ make build-image
87+
```
88+
8989
## License
9090

9191
`semu` is released under the MIT License.

0 commit comments

Comments
 (0)