Update upstream source from tag 'upstream/1.3.0+git20220115'

[sven/fuse-exfat.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..b012eca
--- /dev/null
+++ b/README.md
@@ -0,0 +1,83 @@
+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:
+
+* [git][4]
+* [autoconf][5]
+* [automake][6]
+* [pkg-config][7]
+* fuse-devel (or libfuse-dev)
+* [gcc][8]
+* [make][9]
+
+On Mac OS X:
+
+* autoconf
+* automake
+* pkg-config
+* [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
+    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
+[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