Forked

[rrq/fuse_xattrs.git] / README.md

diff --git a/README.md b/README.md
index f24f0185b7fd1b485a0a10e72d6e60b844f63d5e..97da5ee921fba0f3a3b0565b556235218a53bdd5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,50 +1,38 @@
-[![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 any 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.
+## Original upstream version
 
-## 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
 
-
 ## 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
 
 First you need to download FUSE 2.9 or later from
 http://github.com/libfuse/libfuse.
 
-    mkdir build && cd build
-    cmake ..
-    make
-
-## 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
-
-## Installing
+    $ mkdir build
+    $ cd build
+    build$ cmake ..
+    build$ make
 
-    make install
+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/