TheCloud/dwarfs
1
0
Fork 0
mirror of https://github.com/mhx/dwarfs.git synced 2025-08-03 17:56:12 -04:00
Code Issues Packages Projects Releases Wiki Activity

chore: update README.md

Browse Source
This commit is contained in:
Marcus Holland-Moritz 2024-01-22 12:11:27 +01:00
parent a342ef69b6
commit 55a8b76dd9
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -282,9 +282,10 @@ $ apt install \
libelf-dev \ libelf-dev \
libfmt-dev \ libfmt-dev \
libfuse3-dev \ libfuse3-dev \
libutfcpp-dev \
libgoogle-glog-dev \ libgoogle-glog-dev \
libflac++-dev libutfcpp-dev \
libflac++-dev \
python3-mistletoe
``` ```
Note that when building with `gcc`, the optimization level will be Note that when building with `gcc`, the optimization level will be
@ -386,11 +387,16 @@ $ ninja test
## Usage ## 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 [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) 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 in order to create a writable file system mount on top a read-only
DwarFS image. DwarFS image.
@ -398,6 +404,9 @@ DwarFS image.
A description of the DwarFS filesystem format can be found in A description of the DwarFS filesystem format can be found in
[dwarfs-format](doc/dwarfs-format.md). [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 ## Windows Support
Support for the Windows operating system is currently experimental. Support for the Windows operating system is currently experimental.