Generalized support for referencing resources in external WIMs

[wimlib] / README

diff --git a/README b/README
index a2dc56c3f8a9a2ea37ee762380c70c993043e812..f473d725310359216d42c4eed0c1627a551ce4d5 100644 (file)
--- a/README
+++ b/README
@@ -1,10 +1,10 @@
                                   INTRODUCTION
 
                                   INTRODUCTION
 

-This is wimlib version 1.4.0 (May 2013).  wimlib is a C library that can be
-used to create, modify, extract, and mount files in the Windows Imaging Format
-(WIM files).  These files are normally created by using the `imagex.exe' utility
-on Windows, but wimlib is distributed with a free implementation of ImageX
-called "wimlib-imagex" for both UNIX and Windows.
+This is wimlib version 1.5.0 (August 2013).  wimlib is a C library for creating,
+modifying, extracting, and mounting files in the Windows Imaging Format (WIM
+files).  These files are normally created by using the `imagex.exe' utility on
+Windows, but wimlib is distributed with a free implementation of ImageX called
+"wimlib-imagex" for both UNIX and Windows.

 
                                   INSTALLATION
 
 
                                   INSTALLATION
 


@@ -65,20 +65,21 @@ better than Microsoft's software, especially with multithreaded compression,
 available in wimlib v1.1.0 and later.
 
 The following tables compare the compression ratio and performance for creating
 available in wimlib v1.1.0 and later.
 
 The following tables compare the compression ratio and performance for creating

-a compressed Windows PE image (disk usage of about 524 MB, uncompressed WIM size
-361 MB):
+a compressed x86_64 Windows PE image.  Note: these timings were done on Windows
+7 so that the times would be fully comparable; however, wimlib-imagex may have
+even better performance on Linux.

 
         Table 1. WIM size
 
                                            XPRESS Compression      LZX Compression
 
         Table 1. WIM size
 
                                            XPRESS Compression      LZX Compression

-        wimlib-imagex (v1.2.1):            138,971,353 bytes       131,379,943 bytes
-        Microsoft imagex.exe:              140,406,981 bytes       127,249,176 bytes
+        wimlib-imagex (v1.4.0):            165,301,379 bytes       155,254,385 bytes
+        Microsoft imagex.exe:              167,212,939 bytes       149,973,212 bytes

 
         Table 2. Time to create WIM
 
                                            XPRESS Compression      LZX Compression
 
         Table 2. Time to create WIM
 
                                            XPRESS Compression      LZX Compression

-        wimlib-imagex (v1.2.1, 2 threads): 11 sec                  17 sec
-        Microsoft imagex.exe:              25 sec                  89 sec
+        wimlib-imagex (v1.4.0, 2 threads): 18 sec                  51 sec
+        Microsoft imagex.exe:              25 sec                  93 sec

 
                                   NTFS SUPPORT
 
 
                                   NTFS SUPPORT
 


@@ -228,7 +229,10 @@ you do not have libntfs-3g 2011-4-12 or later available, you must configure
 wimlib with --without-ntfs-3g.  On FreeBSD, before mounting a WIM you need to
 load the POSIX message queue module (run `kldload mqueuefs').
 
 wimlib with --without-ntfs-3g.  On FreeBSD, before mounting a WIM you need to
 load the POSIX message queue module (run `kldload mqueuefs').
 

-wimlib has not been tested on big-endian CPU architectures.
+The code has primarily been tested on x86 and x86_64 CPUs, but it's written to
+be portable to other architectures and I've also tested it on ARM.  However,
+although the code is written to correctly deal with endianness, it has not yet
+actually been tested on a big-endian architecture.

 
                                    REFERENCES
 
 
                                    REFERENCES
 


@@ -242,9 +246,9 @@ see the code and/or ask me if you have any questions about the WIM file format
 as it exists in reality and not as it exists in Microsoft's poorly written
 documentation.
 
 as it exists in reality and not as it exists in Microsoft's poorly written
 documentation.
 

-The code in ntfs-apply.c and ntfs-capture.c uses the NTFS-3g library, which is a
-library for reading and writing to NTFS filesystems (the filesystem used by
-recent versions of Windows).  See
+The code in ntfs-3g_apply.c and ntfs-3g_capture.c uses the NTFS-3g library,
+which is a library for reading and writing to NTFS filesystems (the filesystem
+used by recent versions of Windows).  See

 http://www.tuxera.com/community/ntfs-3g-download/ for more information.
 
 lzx-decompress.c, the code to decompress WIM file resources that are compressed
 http://www.tuxera.com/community/ntfs-3g-download/ for more information.
 
 lzx-decompress.c, the code to decompress WIM file resources that are compressed


@@ -278,7 +282,7 @@ http://www.ultimatedeployment.org/.
 
 You can see the documentation about Microsoft's version of ImageX at
 http://technet.microsoft.com/en-us/library/cc749447(v=ws.10).aspx, so you can
 
 You can see the documentation about Microsoft's version of ImageX at
 http://technet.microsoft.com/en-us/library/cc749447(v=ws.10).aspx, so you can

-see how it compares to the version provided by this library.
+see how it compares to wimlib-imagex.

 
 If you are looking for a UNIX archive format that provides features similar to
 WIM, I recommend you take a look at SquashFS (http://squashfs.sourceforge.net/).
 
 If you are looking for a UNIX archive format that provides features similar to
 WIM, I recommend you take a look at SquashFS (http://squashfs.sourceforge.net/).