Skip to content

Commit

Permalink
README: add test section and qcow2 utility
Browse files Browse the repository at this point in the history
Signed-off-by: Ming Lei <tom.leiming@gmail.com>
  • Loading branch information
ming1 committed Jan 2, 2024
1 parent 7073344 commit 6f90d90
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,10 @@ This project is based on qcow2 implementation from `rsd`[^1]
Motivation of this project is for supporting ublk-qcow2[^4], but turns out it
becomes one generic async qcow2 library.

Also one binary utility is shipped in this project, which can dump qcow2 meta,
Also one utility is included in this project, which can dump qcow2 meta,
show any meta related statistics of the image, check image meta integrity &
host cluster leak, format qcow2 image, ...
host cluster leak, format qcow2 image, ..., and could provide more information
compared with `qemu-img`.

## Example

Expand All @@ -51,6 +52,13 @@ host cluster leak, format qcow2 image, ...

```

## Test

- for running the built-in test, `qemu-img` is required, so package of
`qemu-utils`(Debian/Ubuntu) or `qemu-img`(Fedora, RHEL, ...) needs to
be installed


## License

This project is licensed under MIT OR Apache.
Expand Down

0 comments on commit 6f90d90

Please sign in to comment.