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 * scons
  20 * fuse-devel (or libfuse-dev)
  21 * gcc
  22
  23 Get the source code, change directory and compile:
  24
  25 ```
  26 git clone https://github.com/relan/exfat.git
  27 cd exfat
  28 scons
  29 ```
  30
  31 Then install driver and utilities:
  32
  33 ```
  34 sudo scons install
  35 ```
  36
  37 # Mounting
  38
  39 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):
  40
  41 ```
  42 sudo mount.exfat-fuse /dev/sdXn /mnt/exfat
  43 ```
  44
  45 where /dev/sdXn is the partition special file, /mnt/exfat is a mountpoint.
  46
  47 # Feedback
  48
  49 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!