Namespaces are disabled by default (can be enabled at runtime with a flag). OSX compa...

[rrq/fuse_xattrs.git] / README.md

diff --git a/README.md b/README.md
index 62e83994a9134c4aab933c247ee5ae947e8929be..ea636f03b7c0d429d8c071d0d3d2a52267299153 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/fbarriga/fuse_xattrs.svg?branch=master)](https://travis-ci.org/fbarriga/fuse_xattrs)
+
 ## Abstract
 
 This filesystem provides xattr support using sidecar files.
@@ -12,23 +14,47 @@ http://github.com/fbarriga/fuse_xattrs
 
 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
 
+## Distribution packages
+
+Archlinux (https://aur.archlinux.org/packages/fuse_xattrs/):
+
+    yaourt -S fuse_xattrs
 
-## Installing
+
+## Building
 
 First you need to download FUSE 2.9 or later from
 http://github.com/libfuse/libfuse.
 
-    mkdir build
-    cd build
+    mkdir build && cd build
     cmake ..
     make
 
+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