use larger string heap

[rrq/fuse_xattrs.git] / README.md

diff --git a/README.md b/README.md
index 62e83994a9134c4aab933c247ee5ae947e8929be..7082cb3c3339e410de8cf5c7ebd8182f6de217c8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,39 +1,40 @@
-## Abstract
+# fuse_xattrs
 
-This filesystem provides xattr 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".
 
-## Latest version
-
-The latest version and more information can be found on
+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 mountpoint
+    fuse_xattrs source_directory mountpoint
 
 To unmount the filesystem:
 
     fusermount -u mountpoint
 
+## Building
 
-## Installing
+libfuse-dev
+libacl1-dev
+libattr1-dev
 
-First you need to download FUSE 2.9 or later from
-http://github.com/libfuse/libfuse.
+    $ mkdir build
+    $ cd build
+    build$ cmake ..
+    build$ make
 
-    mkdir build
-    cd build
-    cmake ..
-    make
+attr
 
+Dependencies:
 
-## Links
+    cmake
+    osxfuse (macOS only)
 
-- http://man7.org/linux/man-pages/man2/setxattr.2.html
-- http://man7.org/linux/man-pages/man2/listxattr.2.html
-- http://man7.org/linux/man-pages/man2/getxattr.2.html
-- http://man7.org/linux/man-pages/man3/errno.3.html
-- https://www.freedesktop.org/wiki/CommonExtendedAttributes/