add sroot option to help text

[rrq/fuse_xattrs.git] / README.md

diff --git a/README.md b/README.md
index d57d794959e6515033a2367517ba13652db8182f..7082cb3c3339e410de8cf5c7ebd8182f6de217c8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,40 @@
 # fuse_xattrs
-add xattrs support using sidecar files.
+
+This is a fuse filesystem that provides extended attribute (xattr)
+support over some other filesystem by using "sidecar files", i.e.
+separate files that hold the extended attributes only, named by the
+same pathname as the attributed file or directory with an additional
+extension ".xattr".
+
+This software originated as version 0.4 of
+http://github.com/fbarriga/fuse_xattrs
+at 2021-11-11.
+
+## How to mount a filesystem
+
+Once fuse_xattrs is installed (see next section) running it is very simple:
+
+    fuse_xattrs source_directory mountpoint
+
+To unmount the filesystem:
+
+    fusermount -u mountpoint
+
+## Building
+
+libfuse-dev
+libacl1-dev
+libattr1-dev
+
+    $ mkdir build
+    $ cd build
+    build$ cmake ..
+    build$ make
+
+attr
+
+Dependencies:
+
+    cmake
+    osxfuse (macOS only)
+