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 d57d794959e6515033a2367517ba13652db8182f..ea636f03b7c0d429d8c071d0d3d2a52267299153 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,65 @@
-# fuse_xattrs
-add xattrs support using sidecar files.
+[![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.
+
+## Latest version
+
+The latest version and more information can be found on
+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 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
+
+First you need to download FUSE 2.9 or later from
+http://github.com/libfuse/libfuse.
+
+    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
+
+- 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/