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

Add TOC

Browse Source
This commit is contained in:
Marcus Holland-Moritz 2020-12-07 23:04:11 +01:00
parent f3b76ad69b
commit a0364e98be
1 changed files with 29 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -4,6 +4,21 @@
A fast high compression read-only file system A fast high compression read-only file system
## Table of contents
* [Overview](#overview)
* [History](#history)
* [Building and Installing](#building-and-installing)
* [Dependencies](#dependencies)
* [Building](#building)
* [Installing](#installing)
* [Experimental Python Scripting Support](#experimental-python-scripting-support)
* [Usage](#usage)
* [Comparison](#comparison)
* [With SquashFS](#with-squashfs)
* [With SquashFS & xz](#with-squashfs--xz)
* [With wimlib](#with-wimlib)
## Overview ## Overview
![Alt text](doc/screenshot.png?raw=true "DwarFS Screenshot") ![Alt text](doc/screenshot.png?raw=true "DwarFS Screenshot")
@ -110,7 +125,7 @@ will be automatically resolved if you build with tests.
A good starting point for apt-based systems is probably: A good starting point for apt-based systems is probably:
# apt install \ $ apt install \
g++ \ g++ \
clang \ clang \
cmake \ cmake \
@ -192,27 +207,27 @@ These measurements were made with gcc-9.3.0 and clang-10.0.1.
Firstly, either clone the repository... Firstly, either clone the repository...
# git clone --recurse-submodules https://github.com/mhx/dwarfs $ git clone --recurse-submodules https://github.com/mhx/dwarfs
# cd dwarfs $ cd dwarfs
...or unpack the release archive: ...or unpack the release archive:
# tar xvf dwarfs-x.y.z.tar.bz2 $ tar xvf dwarfs-x.y.z.tar.bz2
# cd dwarfs-x.y.z $ cd dwarfs-x.y.z
Once all dependencies have been installed, you can build DwarFS Once all dependencies have been installed, you can build DwarFS
using: using:
# mkdir build $ mkdir build
# cd build $ cd build
# cmake .. -DWITH_TESTS=1 $ cmake .. -DWITH_TESTS=1
# make -j$(nproc) $ make -j$(nproc)
If possible, try building with clang as your compiler, this will If possible, try building with clang as your compiler, this will
make DwarFS significantly faster. If you have both gcc and clang make DwarFS significantly faster. If you have both gcc and clang
installed, use: installed, use:
# CC=clang CXX=clang++ cmake .. -DWITH_TESTS=1 $ CC=clang CXX=clang++ cmake .. -DWITH_TESTS=1
To build with experimental Lua support, you need to install both To build with experimental Lua support, you need to install both
`lua` and `luabind`. The latter isn't very well maintained and I `lua` and `luabind`. The latter isn't very well maintained and I
@ -221,13 +236,13 @@ to the `cmake` command line to enable Lua support.
You can then run tests with: You can then run tests with:
# make test $ make test
### Installing ### Installing
Installing is as easy as: Installing is as easy as:
# sudo make install $ sudo make install
Though you don't have to install the tools to play with them. Though you don't have to install the tools to play with them.
@ -236,13 +251,13 @@ Though you don't have to install the tools to play with them.
You can build `mkdwarfs` with experimental support for Python You can build `mkdwarfs` with experimental support for Python
scripting: scripting:
# cmake .. -DWITH_TESTS=1 -DWITH_PYTHON=1 $ cmake .. -DWITH_TESTS=1 -DWITH_PYTHON=1
This also requires Boost.Python. If you have multiple Python This also requires Boost.Python. If you have multiple Python
versions installed, you can explicitly specify the version to versions installed, you can explicitly specify the version to
build against: build against:
# cmake .. -DWITH_TESTS=1 -DWITH_PYTHON=1 -DWITH_PYTHON_VERSION=3.8 $ cmake .. -DWITH_TESTS=1 -DWITH_PYTHON=1 -DWITH_PYTHON_VERSION=3.8
Note that only Python 3 is supported. You can take a look at Note that only Python 3 is supported. You can take a look at
[scripts/example.py](scripts/example.py) to get an idea for [scripts/example.py](scripts/example.py) to get an idea for