Imported Upstream version 1.2.4

[sven/exfat-utils.git] / README

diff --git a/README b/README
index 8f2fe85cb9a9689824098855ce027a9bc8a93f7b..500d72234ab2037b78c908b71f7b07ccf0bf8640 100644 (file)
--- a/README
+++ b/README
@@ -7,7 +7,6 @@ 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.
@@ -15,40 +14,56 @@ Most GNU/Linux distributions already have fuse-exfat and exfat-utils in their re
 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:
 
-* pkg-config
+* [pkg-config][7]
 * fuse-devel (or libfuse-dev)
-* gcc
-* make
+* [gcc][8]
+* [make][9]
+
+On Mac OS X:
+
+* pkg-config
+* [OSXFUSE][10]
+* [Xcode][11] (legacy versions include autotools but their versions are too old)
+
+On OpenBSD:
+
 
 Get the source code, change directory and compile:
 
-    ./configure --prefix=/usr
+    ./configure
     make
 
-Then install driver and utilities:
+Then install driver and utilities (from root):
 
-    sudo make install
+    make install
 
-You can remove them using this command:
+You can remove them using this command (from root):
 
-    sudo make uninstall
+    make uninstall
 
 Mounting
 --------
 
-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):
+Modern GNU/Linux distributions (with [util-linux][12] 2.18 or later) will mount exFAT volumes automatically. Anyway, you can mount manually (from root):
 
-    sudo mount.exfat-fuse /dev/sdXn /mnt/exfat
+    mount.exfat-fuse /dev/spec /mnt/exfat
 
-where /dev/sdXn is the partition special file, /mnt/exfat is a mountpoint.
+where /dev/spec is the [device file][13], /mnt/exfat is a mountpoint.
 
 Feedback
 --------
 
 If you have any questions, issues, suggestions, bug reports, etc. please create an [issue][3]. Pull requests are also welcome!
 
-[1]: http://en.wikipedia.org/wiki/ExFAT
-[2]: http://en.wikipedia.org/wiki/Filesystem_in_Userspace
+[1]: https://en.wikipedia.org/wiki/ExFAT
+[2]: https://en.wikipedia.org/wiki/Filesystem_in_Userspace
 [3]: https://github.com/relan/exfat/issues
+[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