Make fuse3 support optional and document.

[bcachefs-tools-debian] / INSTALL

diff --git a/INSTALL b/INSTALL
index 90b35853a10e230a03159d27550c4fdec101ba73..e344c53c5086410206bb3b86daa6a176c02d9670 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,18 +1,52 @@
+-- Getting started --
 
 Dependencies:
 
- * libattr1
+ * libaio
  * libblkid
- * libuuid
+ * libkeyutils
+ * liblz4
  * libscrypt
  * libsodium
- * libkeyutils
  * liburcu
+ * libuuid
+ * libzstd
  * pkg-config
  * zlib1g
+ * valgrind
 
 On debian, you can install these with
-    apt install -y pkg-config libblkid-dev uuid-dev libscrypt-dev libsodium-dev
-       libkeyutils-dev liburcu-dev zlib1g-dev libattr1-dev
+    apt install -y pkg-config libaio-dev libblkid-dev libkeyutils-dev \
+        liblz4-dev libscrypt-dev libsodium-dev liburcu-dev libzstd-dev \
+        uuid-dev zlib1g-dev valgrind
 
 Then, just make && make install
+
+
+-- Experimental features --
+
+Experimental fuse support is currently disabled by default. Fuse support is at
+an early stage and may corrupt your filesystem, so it should only be used for
+testing. To enable, you'll also need to add:
+
+* libfuse3
+
+On debian:
+    apt install -y libfuse3-dev
+
+Then, make using the BCACHEFS_FUSE environment variable:
+
+BCACHEFS_FUSE=1 make &&
+
+
+-- Tests --
+
+Some tests are available to validate the "bcachefs" binary.  The tests depend
+on python3 pytest.
+
+On debian:
+   apt install -u python3-pytest
+
+Then, you can run the tests via:
+
+   make check