Make WIM mounting work on FreeBSD

[wimlib] / README

diff --git a/README b/README
index c0dadaad14a2d6e847db1fae164d534c35768a98..2fa925e981eaa548b4d547b773f262ffaacfe04b 100644 (file)
--- a/README
+++ b/README
@@ -1,9 +1,9 @@
                                   WIMLIB                                    
 
-This is wimlib version 1.0.0 (September 2012).  wimlib can be used to read,
+This is wimlib version 1.0.1 (September 2012).  wimlib can be used to read,
 write, and mount files in the Windows Imaging Format (WIM files).  These
 files are normally created by using the `imagex.exe' utility on Windows,
-but this library provides a free implementetion of imagex for UNIX-based
+but this library provides a free implementation of imagex for UNIX-based
 systems.
 
                                   WIM FILES
@@ -25,6 +25,8 @@ format, and LZX compression format.  The XPRESS documentation is acceptable, but
 the LZX documentation is not entirely correct, and the WIM documentation itself
 is very incomplete and is of unacceptable quality.
 
+A WIM file may be either stand-alone or split into multiple parts.
+
                                   WINDOWS PE
 
 A major use for this library is to create customized images of Windows PE, the
@@ -92,11 +94,10 @@ server for PXE booting.  See the main page `doc/mkwinpeiso.1' for more details.
 
 * libntfs-3g
        Unless configured with --without-ntfs-3g, wimlib requires the library
-       and headers for libntfs-3g to be installed.  Currently, the libntfs-3g
-       version dated 2012-1-15 is required because I've cloned some of the code
-       from the library, and it needs to compiled against the same version.
-       I'm hoping to be able to use future version of libntfs-3g without code
-       cloning after submitting some patches, however.
+       and headers for libntfs-3g version 2011-4-12 or later to be installed.
+       Versions dated 2010-3-6 and earlier do not work because they are missing
+       the header xattrs.h (and the file xattrs.c, which contains functions we
+       need).
 
 * cdrkit (optional)
 * mtools (optional)
@@ -183,8 +184,11 @@ wimlib has mostly been developed and tested on x86_64 (64-bit) GNU/Linux.
 
 It has been tested on x86 (32-bit) GNU/Linux occasionally.
 
-I have tested a previous version of wimlib on FreeBSD and it worked, but this is
-not well tested, especially with the more recent versions of this software.
+wimlib may work on FreeBSD.  However, this is not well tested.  If you do not
+have libntfs-3g 2011-4-12 or later available, you must configure with
+--without-ntfs-3g.  Also, GNU coreutils is needed to run the test suite.  Before
+mounting a WIM you need to load the POSIX message queue module (run `kldload
+mqueuefs').  
 
 wimlib should work on big endian machines but it has not been tested.
 
@@ -247,7 +251,11 @@ created in a directory named `html'.
                                    LICENSE
 
 As of version 1.0.0, wimlib is released under the GNU GPL version 3.0 or later.
-This includes the files in the `programs' directory.
+This includes the files in the `programs' directory as well as the files in the
+`src' directory.
+
+wimlib is independently developed and does not contain any code, data, or files
+copyrighted by Microsoft.  It is not known to be affected by any patents.
 
                                   DISCLAIMER