README.md

   1 About
   2 -----
   3
   4 This project aims to provide a full-featured [exFAT][1] file system implementation for Unix-like systems. It consists of a [FUSE][2] module (fuse-exfat) and a set of utilities (exfat-utils).
   5
   6 Supported operating systems:
   7
   8 * GNU/Linux
   9 * Mac OS X 10.5 or later
  10 * FreeBSD
  11 * OpenBSD
  12
  13 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.
  14
  15 Compiling
  16 ---------
  17
  18 To build this project under GNU/Linux you need to install the following packages:
  19
  20 * git
  21 * autoconf
  22 * automake
  23 * pkg-config
  24 * fuse-devel (or libfuse-dev)
  25 * gcc
  26 * make
  27
  28 Get the source code, change directory and compile:
  29
  30     git clone https://github.com/relan/exfat.git
  31     cd exfat
  32     autoreconf --install
  33     ./configure --prefix=/usr
  34     make
  35
  36 Then install driver and utilities:
  37
  38     sudo make install
  39
  40 You can remove them using this command:
  41
  42     sudo make uninstall
  43
  44 Mounting
  45 --------
  46
  47 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):
  48
  49     sudo mount.exfat-fuse /dev/sdXn /mnt/exfat
  50
  51 where /dev/sdXn is the partition special file, /mnt/exfat is a mountpoint.
  52
  53 Feedback
  54 --------
  55
  56 If you have any questions, issues, suggestions, bug reports, etc. please create an [issue][3]. Pull requests are also welcome!
  57
  58 [1]: http://en.wikipedia.org/wiki/ExFAT
  59 [2]: http://en.wikipedia.org/wiki/Filesystem_in_Userspace
  60 [3]: https://github.com/relan/exfat/issues