README.md

   1 # About
   2
   3 This project aims to provide a full-featured [exFAT](http://en.wikipedia.org/wiki/ExFAT) file system implementation for Unix-like systems. It consists of a [FUSE](http://en.wikipedia.org/wiki/Filesystem_in_Userspace) module (fuse-exfat) and a set of utilities (exfat-utils).
   4
   5 Supported operating systems:
   6
   7 * GNU/Linux
   8 * Mac OS X 10.5 or later
   9 * FreeBSD
  10 * OpenBSD
  11
  12 Most GNU/Linux distributions already have fuse-exfat and exfat-utils in their repositories, so you can just install and use them. The next chapter describes how to compile them from source.
  13
  14 # Compiling
  15
  16 To build this project under GNU/Linux you need to install the following packages:
  17
  18 * git
  19 * autoconf
  20 * automake
  21 * pkg-config
  22 * fuse-devel (or libfuse-dev)
  23 * gcc
  24 * make
  25
  26 Get the source code, change directory and compile:
  27
  28 ```
  29 git clone https://github.com/relan/exfat.git
  30 cd exfat
  31 autoreconf --install
  32 ./configure --prefix=/usr
  33 make
  34 ```
  35
  36 Then install driver and utilities:
  37
  38 ```
  39 sudo make install
  40 ```
  41
  42 # Mounting
  43
  44 Modern GNU/Linux distributions will mount exFAT volumes automatically—util-linux-ng 2.18 (was renamed to util-linux in 2.19) is required for this. Anyway, you can mount manually (you will need root privileges):
  45
  46 ```
  47 sudo mount.exfat-fuse /dev/sdXn /mnt/exfat
  48 ```
  49
  50 where /dev/sdXn is the partition special file, /mnt/exfat is a mountpoint.
  51
  52 # Feedback
  53
  54 If you have any questions, issues, suggestions, bug reports, etc. please create an [issue](https://github.com/relan/exfat/issues). Pull requests are also welcome!