Skip to content

docs: update README for v0.6 release #120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
agicy merged 1 commit into from
Aug 25, 2026
Merged

docs: update README for v0.6 release #120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ help:
@echo " clean - Clean build artifacts"
@echo ""
@echo "Environment variables:"
@echo " ARCH=arm64|riscv|loongarch Target architecture (required)"
@echo " ARCH=arm64|riscv|loongarch|x86_64 Target architecture (required)"
@echo " LOG=LEVEL Log level: LOG_DEBUG LOG_INFO LOG_WARNING LOG_ERR LOG_CRIT (default: LOG_INFO)"
@echo " KDIR=path Linux kernel source path (required)"
@echo " VIRTIO_GPU=y|n Enable GPU support (default: n)"
Expand Down
8 changes: 4 additions & 4 deletions README-zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ hvisor-tool
* 编译命令行工具及内核模块

```bash
make all ARCH=<arch> LOG=<log> KDIR=/path/to/your-linux LIBC=[gnu/musl] VIRTIO_GPU=[y/n] ROOT=/path/to/target_rootfs
make all ARCH=<arch> LOG=<log> KDIR=/path/to/your-linux LIBC=[gnu/musl] VIRTIO_GPU=[y/n]
```

其中，`<arch>`应该为`arm64`和`riscv`之一。
其中，`<arch>`应为`arm64`、`riscv`、`loongarch`和`x86_64`之一。

`<log>`为`LOG_TRACE`、`LOG_DEBUG`、`LOG_INFO`、`LOG_WARN`、`LOG_ERROR`、`LOG_FATAL`之一，用来控制Virtio守护进程的日志输出等级。
`<log>`为`LOG_DEBUG`、`LOG_INFO`、`LOG_WARNING`、`LOG_ERR`、`LOG_CRIT`之一，用来控制Virtio守护进程的日志输出等级。

`/path/to/your-linux`为root linux的kernel源码目录。具体的编译选项请见[Makefile](./Makefile)、[tools/Makefile](./tools/Makefile)、[driver/Makefile](./driver/Makefile)。

Expand All @@ -31,7 +31,7 @@ make all ARCH=<arch> LOG=<log> KDIR=/path/to/your-linux LIBC=[gnu/musl] VIRTIO_G
例如，要编译面向`arm64`的命令行工具，可以执行：

```bash
make all ARCH=arm64 LOG=LOG_WARN KDIR=~/linux
make all ARCH=arm64 LOG=LOG_WARNING KDIR=~/linux
```

即可在`tools/hvisor`和`driver/hvisor.ko`，将其复制到root linux的根文件系统，使用即可。
Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ All operations should be performed in the `hvisor-tool` directory on an x86 host
* Compile the command-line tools and kernel modules

```bash
make all ARCH=<arch> LOG=<log> KDIR=/path/to/your-linux LIBC=[gnu/musl] VIRTIO_GPU=[y/n] ROOT=/path/to/target_rootfs
make all ARCH=<arch> LOG=<log> KDIR=/path/to/your-linux LIBC=[gnu/musl] VIRTIO_GPU=[y/n]
```

Where `<arch>` should be either `arm64` or `riscv`.
Where `<arch>` should be one of `arm64`, `riscv`, `loongarch`, or `x86_64`.

`<log>` can be one of the following: `LOG_TRACE`, `LOG_DEBUG`, `LOG_INFO`, `LOG_WARN`, `LOG_ERROR`, or `LOG_FATAL`, to control the log output level of the Virtio daemon.
`<log>` can be one of the following: `LOG_DEBUG`, `LOG_INFO`, `LOG_WARNING`, `LOG_ERR`, or `LOG_CRIT`, to control the log output level of the Virtio daemon.

`/path/to/your-linux` is the kernel source directory for the root Linux. Specific compilation options can be found in [Makefile](./Makefile), [tools/Makefile](./tools/Makefile), and [driver/Makefile](./driver/Makefile).

Expand All @@ -31,7 +31,7 @@ Where `<arch>` should be either `arm64` or `riscv`.
For example, to compile the command-line tools for `arm64`, you can run:

```bash
make all ARCH=arm64 LOG=LOG_WARN KDIR=~/linux
make all ARCH=arm64 LOG=LOG_WARNING KDIR=~/linux
```

This will generate the tools in `tools/hvisor` and the kernel module in `driver/hvisor.ko`, which you can copy to the root Linux root filesystem and use.
Expand Down
Loading