diff --git a/README.md b/README.md index 9276779..bde760e 100644 --- a/README.md +++ b/README.md @@ -32,10 +32,35 @@ The fields are: * Referenced: apparent size of files (minus holes) The ioctl used requires root. +# Installation distributions repositories: +The recommended way to install compsize is via distributions repositories official repositories -# Installation: +## Debian/Ubuntu example: +````bash +sudo apt install btrfs-compsize +```` +To run: +````bash +sudo compsize . +```` + +# Installation from source: Besides regular C toolchain, you need btrfs userspace headers. On Debian (incl. derivatives like Ubuntu) they're in libbtrfs-dev, SuSE ships them inside libbtrfs-devel, they used to come with btrfs-progs before. Required kernel: 3.16, btrfs-progs: 3.18 (untested!). + +## Debian/Ubuntu example: + + +````bash +git clone git@github.com:kilobyte/compsize.git +sudo apt install libbtrfs-dev +cd compsize +make +```` +To run: +````bash +sudo ./compsize . +````