X-Git-Url: https://git.sven.stormbind.net/?p=sven%2Ffuse-exfat.git;a=blobdiff_plain;f=README;fp=README;h=2b98bbce3c1cf7fe7298d41ed7ef881a311059f7;hp=0000000000000000000000000000000000000000;hb=aa03032454625361e1abc1cf80f4db0492ae5b81;hpb=b8b3f5e8940dd7a0ce964dfecd8c6c6139dab421

diff --git a/README b/README
new file mode 100644
index 0000000..2b98bbc
--- /dev/null
+++ b/README
@@ -0,0 +1,69 @@
+About
+-----
+
+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
+
+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
+---------
+
+To build this project on GNU/Linux you need to install the following packages:
+
+* [pkg-config][7]
+* fuse-devel (or libfuse-dev)
+* [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
+    make
+
+Then install driver and utilities (from root):
+
+    make install
+
+You can remove them using this command (from root):
+
+    make uninstall
+
+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):
+
+    mount.exfat-fuse /dev/spec /mnt/exfat
+
+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]: 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