Namespaces are disabled by default (can be enabled at runtime with a flag). OSX compa...
[rrq/fuse_xattrs.git] / README.md
index b2411ef706ececed29a6732e44308844153c13b0..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,12 +14,18 @@ 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
+
 
 ## Building
 
@@ -28,6 +36,11 @@ http://github.com/libfuse/libfuse.
     cmake ..
     make
 
+Dependencies:
+
+    cmake
+    osxfuse (macOS only)
+
 ## Code Coverage
 
     mkdir build && cd build
@@ -35,6 +48,10 @@ http://github.com/libfuse/libfuse.
     make
     make fuse_xattrs_coverage
 
+Dependencies:
+
+    easy_install-3.6 xattr==0.9.1
+    
 ## Installing
 
     make install