mirror of
https://github.com/mhx/dwarfs.git
synced 2025-08-03 17:56:12 -04:00
chore: update README.md
This commit is contained in:
parent
a342ef69b6
commit
55a8b76dd9
19
README.md
19
README.md
@ -282,9 +282,10 @@ $ apt install \
|
||||
libelf-dev \
|
||||
libfmt-dev \
|
||||
libfuse3-dev \
|
||||
libutfcpp-dev \
|
||||
libgoogle-glog-dev \
|
||||
libflac++-dev
|
||||
libutfcpp-dev \
|
||||
libflac++-dev \
|
||||
python3-mistletoe
|
||||
```
|
||||
|
||||
Note that when building with `gcc`, the optimization level will be
|
||||
@ -386,11 +387,16 @@ $ ninja test
|
||||
|
||||
## Usage
|
||||
|
||||
Please check out the man pages for [mkdwarfs](doc/mkdwarfs.md),
|
||||
Please check out the manual pages for [mkdwarfs](doc/mkdwarfs.md),
|
||||
[dwarfs](doc/dwarfs.md), [dwarfsck](doc/dwarfsck.md) and
|
||||
[dwarfsextract](doc/dwarfsextract.md).
|
||||
[dwarfsextract](doc/dwarfsextract.md). You can also access the manual
|
||||
pages using the `--man` option to each binary, e.g.:
|
||||
|
||||
The [dwarfs](doc/dwarfs.md) man page also shows an example for setting
|
||||
```
|
||||
$ mkdwarfs --man
|
||||
```
|
||||
|
||||
The [dwarfs](doc/dwarfs.md) manual page also shows an example for setting
|
||||
up DwarFS with [overlayfs](https://www.kernel.org/doc/Documentation/filesystems/overlayfs.txt)
|
||||
in order to create a writable file system mount on top a read-only
|
||||
DwarFS image.
|
||||
@ -398,6 +404,9 @@ DwarFS image.
|
||||
A description of the DwarFS filesystem format can be found in
|
||||
[dwarfs-format](doc/dwarfs-format.md).
|
||||
|
||||
A high-level overview of the internal operation of `mkdwarfs` is shown
|
||||
in [this sequence diagram](doc/mkdwarfs-sequence.svg).
|
||||
|
||||
## Windows Support
|
||||
|
||||
Support for the Windows operating system is currently experimental.
|
||||
|
Loading…
x
Reference in New Issue
Block a user