use larger string heap
[rrq/fuse_xattrs.git] / README.md
index ea636f03b7c0d429d8c071d0d3d2a52267299153..7082cb3c3339e410de8cf5c7ebd8182f6de217c8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,14 +1,14 @@
-[![Build Status](https://travis-ci.org/fbarriga/fuse_xattrs.svg?branch=master)](https://travis-ci.org/fbarriga/fuse_xattrs)
+# fuse_xattrs
 
-## Abstract
+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 filesystem provides xattr support using sidecar files.
-
-## 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
 
@@ -20,46 +20,21 @@ To unmount the filesystem:
 
     fusermount -u mountpoint
 
-## Distribution packages
-
-Archlinux (https://aur.archlinux.org/packages/fuse_xattrs/):
-
-    yaourt -S fuse_xattrs
-
-
 ## Building
 
-First you need to download FUSE 2.9 or later from
-http://github.com/libfuse/libfuse.
+libfuse-dev
+libacl1-dev
+libattr1-dev
+
+    $ mkdir build
+    $ cd build
+    build$ cmake ..
+    build$ make
 
-    mkdir build && cd build
-    cmake ..
-    make
+attr
 
 Dependencies:
 
     cmake
     osxfuse (macOS only)
 
-## Code Coverage
-
-    mkdir build && cd build
-    cmake -DENABLE_CODECOVERAGE=1 -DCMAKE_C_COMPILER=/usr/bin/gcc -DCMAKE_BUILD_TYPE=Debug ..
-    make
-    make fuse_xattrs_coverage
-
-Dependencies:
-
-    easy_install-3.6 xattr==0.9.1
-    
-## Installing
-
-    make install
-
-## Links
-
-- 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/