- WIMLIB
-
-This is wimlib version 1.2.0 (November 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 implementation of imagex for UNIX-based systems.
-
- WIM FILES
-
-A Windows Imaging (WIM) file is an archive. Like some other archive formats
-such as ZIP, files in WIM archives may be compressed. WIM archives support two
-Microsoft-specific compression formats: LZX and XPRESS. Both are based on LZ77
-and Huffman encoding, and both are supported by wimlib.
-
-Unlike ZIP files, WIM files can contain multiple independent toplevel directory
-trees known as images. While each image has its own metadata describing a
-directory tree and file access modes, files are not duplicated for each image;
-instead, each file is included only once in the entire WIM. Microsoft did this
-so that in one WIM file, they could do things like have 5 different versions of
-Windows that are almost exactly the same.
-
-Microsoft provides documentation for the WIM file format, XPRESS compression
-format, and LZX compression format. The XPRESS documentation is acceptable, but
-the LZX documentation is not entirely correct, and the WIM documentation itself
-is incomplete.
-
-A WIM file may be either stand-alone or split into multiple parts.
-
- PROGRAMS
-
-wimlib provides a public API for other programs to use, but also comes with two
-programs: `imagex' and `mkwinpeimg'.
-
-`imagex' is intended to be like the imagex.exe program from Windows. `imagex'
-can be used to create, extract, and mount WIM files. Both read-only and
-read-write mounts are supported. See the man page `doc/imagex.1' for more
-details.
-
-`mkwinpeimg' is shell script that makes it easy to create a customized bootable
-image of Windows PE that can be put on a CD or USB drive, or published on a
-server for PXE booting. See the main page `doc/mkwinpeimg.1' for more details.
-
- COMPRESSION RATIO
-
-wimlib can create XPRESS or LZX compressed WIM archives. As of wimlib v1.0.3,
-the XPRESS compression ratio is slightly better than that provided by
-Microsoft's software, while the LZX compression ratio is approaching that of
-Microsoft's software but is not quite there yet. Running time is as good as or
-better than Microsoft's software, especially with multithreaded compression,
-available in v1.1.0 and later.
+ INTRODUCTION
+
+This is wimlib version 1.5.2 (November 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-like systems and Windows.
+
+ INSTALLATION
+
+To install wimlib and wimlib-imagex on Windows you simply need to download and
+extract the ZIP file containing the latest binaries from the SourceForge page
+(http://sourceforge.net/projects/wimlib/), which you may have already done.
+
+To install wimlib and wimlib-imagex on UNIX-like systems (with Linux being the
+primary supported and tested platform), you must compile the source code, which
+is also available at http://sourceforge.net/projects/wimlib/. Alternatively,
+check if a package has been prepared for your Linux distribution. Example files
+for Debian and RPM packaging are in the debian/ and rpm/ directories.
+
+ WIM FILES
+
+A Windows Imaging (WIM) file is an archive designed primarily for archiving
+Windows filesystems. However, it can be used on other platforms as well, with
+some limitations. Like some other archive formats such as ZIP, files in WIM
+archives may be compressed. WIM files support two compression formats: LZX and
+XPRESS *. Both are supported by wimlib.
+
+A WIM file consists of one or more "images". Each image is an independent
+top-level directory structure and is logically separate from all other images in
+the WIM. Each image has a name as well as a 1-based index in the WIM file. To
+save space, WIM archives automatically combine all duplicate files across all
+images.
+
+A WIM file may be either stand-alone or split into multiple parts. Split WIMs
+are read-only and cannot be modified.
+
+* Note: The Windows 8 WIMGAPI apparently adds a third format, LZMS, but it is
+ not documented and is incompatible with ImageX and Dism. It is unclear if
+ this new format is actually being used for anything.
+
+ IMAGEX IMPLEMENTATION
+
+wimlib itself is a C library, and it provides a documented public API (See:
+http://wimlib.sourceforge.net) for other programs to use. However, it is also
+distributed with a command-line program called "wimlib-imagex" that uses this
+library to implement an imaging tool similar to Microsoft's ImageX.
+wimlib-imagex supports almost all the capabilities of Microsoft's ImageX as well
+as additional capabilities. wimlib-imagex works on both UNIX-like systems and
+Windows, although some features differ between the platforms.
+
+Run `wimlib-imagex' with no arguments to see an overview of the available
+commands and their syntax. For additional documentation:
+
+ * If you have installed wimlib-imagex on a UNIX-like system, you will find
+ further documentation in the man pages; run `man wimlib-imagex' to get
+ started.
+
+ * If you have downloaded the Windows binary distribution, you will find the
+ documentation for wimlib-imagex in PDF format in the "doc" directory,
+ ready for viewing with any PDF viewer. Please note that although the PDF
+ files are converted from UNIX-style "man pages", they do document
+ Windows-specific behavior when appropriate.
+
+ COMPRESSION RATIO
+
+wimlib (and wimlib-imagex) can create XPRESS or LZX compressed WIM archives.
+Currently, the XPRESS compression ratio is slightly better than that provided by
+Microsoft's software, while by default the LZX compression ratio is approaching
+that of Microsoft's software but is not quite there yet. Running time is as
+good as or better than Microsoft's software, especially with multithreaded
+compression, available in wimlib v1.1.0 and later.