OSDN Git Service

Revert "Use fuse_main() instead of lower level functions."
[android-x86/external-exfat.git] / README.md
index cfcfa7a..b012eca 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,54 +1,83 @@
-# About
+About
+-----
 
-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).
+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).
 
 Supported operating systems:
 
 * GNU/Linux
 * Mac OS X 10.5 or later
 * FreeBSD
-* OpenBSD
 
 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.
 
-# Compiling
+Compiling
+---------
 
-To build this project under GNU/Linux you need to install the following packages:
+To build this project on GNU/Linux you need to install the following packages:
+
+* [git][4]
+* [autoconf][5]
+* [automake][6]
+* [pkg-config][7]
+* fuse-devel (or libfuse-dev)
+* [gcc][8]
+* [make][9]
+
+On Mac OS X:
 
-* git
 * autoconf
 * automake
 * pkg-config
-* fuse-devel (or libfuse-dev)
-* gcc
-* make
+* [OSXFUSE][10]
+* [Xcode][11] (legacy versions include autotools but their versions are too old)
+
+On OpenBSD:
+
+* git
+* autoconf (set AUTOCONF_VERSION environment variable)
+* automake (set AUTOMAKE_VERSION environment variable)
 
 Get the source code, change directory and compile:
 
-```
-git clone https://github.com/relan/exfat.git
-cd exfat
-autoreconf --install
-./configure --prefix=/usr
-make
-```
+    git clone https://github.com/relan/exfat.git
+    cd exfat
+    autoreconf --install
+    ./configure
+    make
+
+Then install driver and utilities (from root):
+
+    make install
+
+You can remove them using this command (from root):
 
-Then install driver and utilities:
+    make uninstall
 
-```
-sudo make install
-```
+Mounting
+--------
 
-# Mounting
+Modern GNU/Linux distributions (with [util-linux][12] 2.18 or later) will mount exFAT volumes automatically. Anyway, you can mount manually (from root):
 
-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):
+    mount.exfat-fuse /dev/spec /mnt/exfat
 
-```
-sudo mount.exfat-fuse /dev/sdXn /mnt/exfat
-```
+where /dev/spec is the [device file][13], /mnt/exfat is a mountpoint.
 
-where /dev/sdXn is the partition special file, /mnt/exfat is a mountpoint.
+Feedback
+--------
 
-# Feedback
+If you have any questions, issues, suggestions, bug reports, etc. please create an [issue][3]. Pull requests are also welcome!
 
-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!
+[1]: https://en.wikipedia.org/wiki/ExFAT
+[2]: https://en.wikipedia.org/wiki/Filesystem_in_Userspace
+[3]: https://github.com/relan/exfat/issues
+[4]: https://www.git-scm.com/
+[5]: https://www.gnu.org/software/autoconf/
+[6]: https://www.gnu.org/software/automake/
+[7]: http://www.freedesktop.org/wiki/Software/pkg-config/
+[8]: https://gcc.gnu.org/
+[9]: https://www.gnu.org/software/make/
+[10]: https://osxfuse.github.io/
+[11]: https://en.wikipedia.org/wiki/Xcode
+[12]: https://www.kernel.org/pub/linux/utils/util-linux/
+[13]: https://en.wikipedia.org/wiki/Device_file