Update version: v1.7.0-BETA

[wimlib] / README

diff --git a/README b/README
index 8c9c97ccf33d6ce806a2d533cbed9a5625fe7fc9..3a0ef00b5ab202b16871b91ff77d2567450e2504 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
                                   INTRODUCTION
 
-This is wimlib version 1.6.0 (January 2014).  wimlib is a C library for
+This is wimlib version 1.7.0-BETA (May 2014).  wimlib is a C library for
 creating, modifying, extracting, and mounting files in the Windows Imaging
 Format (WIM files).  These files are normally created using the ImageX
 (imagex.exe) or Dism (Dism.exe) utilities on Windows, but wimlib is distributed
@@ -36,6 +36,10 @@ images.
 A WIM file may be either stand-alone or split into multiple parts.  Split WIMs
 are read-only and cannot be modified.
 
+Since version 1.6.0, wimlib also supports ESD (.esd) files, except when
+encrypted.  These are still WIM files but they use a newer version of the file
+format.
+
                              IMAGEX IMPLEMENTATION
 
 wimlib itself is a C library, and it provides a documented public API (See:
@@ -65,7 +69,7 @@ wimlib (and wimlib-imagex) can create XPRESS, LZX, or LZMS compressed WIM
 archives.  wimlib includes its own compression codecs and does not use the
 compression API available on some versions of Windows.  The below table provides
 the results (file size, in bytes, and time to create, in seconds) of capturing a
-WIM containing a x86 Windows PE image, using various compression types and
+WIM containing an x86 Windows PE image, using various compression types and
 options.  When applicable, the results with the equivalent Microsoft
 implementation in WIMGAPI, which is the library used by ImageX and Dism, are
 included.
@@ -102,20 +106,19 @@ Notes:
        no known equivalent for WIMGAPI.
        Compression chunk size is 32768 (the default for LZX).
 
-   [6] '--compress=recovery' or '--compress=lzms' for wimlib-imagex;
+   [6] '--compress=recovery' or '--compress=LZMS' for wimlib-imagex;
        no known way to create the equivalent with WIMGAPI.
        Compression chunk size is 131072 (the default for LZMS).  Note: this
        compression type is not generally recommended due to its limited
        compatibility with the MS implementations.
 
-   [7] '--compress=recovery --packed-streams' or
-       '--compress=lzms --packed-streams' for wimlib-imagex;
-       WIMCreateFile with WIM_COMPRESSION_LZMS and flag 0x20000000 for WIMGAPI.
-       Compression chunk size in packed resources is 33554432 for wimlib,
-       67108864 for WIMGAPI.  Note: this compression type is not generally
-       recommended due to its limited compatibility with the MS implementations.
-       Also, due to the large chunk size, wimlib uses about 500MB of memory per
-       thread when compressing in this format.
+   [7] '--compress=recovery --solid' or '--compress=LZMS --solid' for
+       wimlib-imagex; WIMCreateFile with WIM_COMPRESSION_LZMS and flag
+       0x20000000 for WIMGAPI.  Compression chunk size in packed resources is
+       33554432 for wimlib, 67108864 for WIMGAPI.  Note: this compression type
+       is not generally recommended due to its limited compatibility with the MS
+       implementations.  Also, due to the large chunk size, wimlib uses about
+       500MB of memory per thread when compressing in this format.
 
 The above timings were done on Windows 8 (x86) so that side-by-side comparisons
 with the Microsoft implementation would be possible; however, wimlib may have
@@ -140,9 +143,9 @@ data streams.
      | WIM (WIMGAPI, XPRESS)          | 825,410      |
      | WIM (wimlib, XPRESS)           | 792,024      |
      | tar.gz (gzip, default)         | 738,796      |
-     | ZIP (Info-Zip, default)        | 735,334      |
+     | ZIP (Info-ZIP, default)        | 735,334      |
      | tar.gz (gzip, -9)              | 733,971      |
-     | ZIP (Info-Zip, -9)             | 732,297      |
+     | ZIP (Info-ZIP, -9)             | 732,297      |
      | WIM (wimlib, LZX quick)        | 722,196      |
      | WIM (WIMGAPI, LZX)             | 651,766      |
      | WIM (wimlib, LZX normal)       | 639,464      |
@@ -179,7 +182,7 @@ platform-dependent way:
 
 For both platforms the code for NTFS capture and extraction is complete enough
 that it is possible to apply an image from the "install.wim" contained in recent
-Windows installation media (Vista, Windows 7, or Windows 8) directly to a NTFS
+Windows installation media (Vista, Windows 7, or Windows 8) directly to an NTFS
 filesystem, and then boot Windows from it after preparing the Boot Configuration
 Data.  In addition, a Windows installation can be captured (or backed up) into a
 WIM file, and then re-applied later.
@@ -369,7 +372,8 @@ WIM, I recommend you take a look at SquashFS (http://squashfs.sourceforge.net/).
                                     LICENSE
 
 As of version 1.0.0, wimlib and all programs and scripts distributed with it are
-released under the GNU GPL version 3.0 or later.
+released under the GNU GPL version 3.0 or later.  See COPYING for details.
+Some individual source files are also released under more permissive licenses.
 
 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.