# Welcome to Squashfs-tools!

This is the official Squashfs-tools repository.

To build and install the tools please read the [Documentation/4.7.5/INSTALL.md file](Documentation/4.7.5/INSTALL.md)

To find out how use the latest release please start by reading [Documentation/4.7.5/README.md](Documentation/4.7.5/README.md)

The latest **4.7.5** release may have already been packaged for your distribution, please see "Packaging status" below.

Thanks

## Contents of the repository

<a href="https://repology.org/project/squashfs-tools/versions">
    <img src="https://repology.org/badge/vertical-allrepos/squashfs-tools.svg" alt="Packaging status" align="right">
</a>

The top-level directory contains the following files:

* **ACKNOWLEDGEMENTS** - This contains some historical acknowlegements, this file has mostly been replaced by the Github issues tracker.
* **CHANGES** - a reverse chronological list of changes from the latest release to the earliest release.
* **CHANGES.md** - the above file in markdown format.
* **CONTRIBUTING.md** - how to ask for features (feature requests), and the way to do Pull requests.
* **COPYING** - GNU general public license file.
* **INSTALL** - where to get the INSTALL file for your version of squashfs-tools.
* **README** - where to get the README for your version of squashfs-tools.
* **README.md** - The file displayed here.
* **SECURITY.md** - Where to report security issues.
* **USAGE** - where to get the USAGE files for your version of squashfs-tools.

The top-level directory has the following directories:

* **Documentation** - this directory contains documentation for various versions of squashfs-tools, and it is split into subdirectories for versions 4.5 through to 4.7.6, the latest released version is 4.7.5, and the development version will become 4.7.6.  It also has a directory containing prebuilt manpages for the latest development version of squashfs-tools.
* **squashfs-tools** - the source code directory, enter this directory and type `make` to build, or `sudo make install` to install.  Edit the Makefile to change the compression algorithms built and other defaults including install PATH, XATTR support, and number of parallel reader threads.