X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=include%2Fwimlib.h;h=23c53ad68bf2affac160ab0dcf995d774c798a32;hp=398a8fb6e7cd758055bb9fb8eb8cf1b62b4c8a5b;hb=19ce03addb8071555d951a965fa0bd7e3ae7224b;hpb=d828350d6065d39d761df687085be478acc88371
diff --git a/include/wimlib.h b/include/wimlib.h
index 398a8fb6..23c53ad6 100644
--- a/include/wimlib.h
+++ b/include/wimlib.h
@@ -31,28 +31,45 @@
/**
* @mainpage
*
- * @section sec_intro Introduction
- *
* This is the documentation for the library interface of wimlib 1.7.0, a C
* library for creating, modifying, extracting, and mounting files in the
* Windows Imaging Format. This documentation is intended for developers only.
* If you have installed wimlib and want to know how to use the @b wimlib-imagex
- * program, please see the README file or manual pages.
+ * program, please see the manual pages and also the README
+ * file.
*
- * @section sec_installing_and_compiling Installing and Compiling
+ * @section sec_installing Installing
*
- * wimlib uses the GNU autotools, so, on UNIX-like systems, it should be easy to
- * install with configure && make && sudo make install
; however,
- * please see the README for more information about installing it.
+ * @subsection UNIX
*
- * To use wimlib in your program after installing it, include wimlib.h and link
- * your program with @c -lwim.
+ * Download the source code from http://sourceforge.net/projects/wimlib/files.
+ * Install the library by running configure && make && sudo make install.
+ * See the README for information about configuration options. To use wimlib in
+ * your program after installing it, include wimlib.h and link your program with
+ * -lwim.
*
- * As of wimlib 1.5.0, wimlib.h is also compatible with C++.
+ * @subsection Windows
*
- * Note: before calling any other function declared in wimlib.h,
- * wimlib_global_init() can (and in some cases, must) be called. See its
- * documentation for more details.
+ * Download the Windows binary distribution with the appropriate architecture
+ * (i686 or x86_64 --- also called "x86" and "amd64" respectively) from http://sourceforge.net/projects/wimlib/files.
+ * Link your program with the libwim-15.dll file. Make sure to also download
+ * the source code so you can get wimlib.h, as it is not included in the binary
+ * distribution. If you need to access the DLL from other programming
+ * languages, note that the calling convention is "cdecl".
+ *
+ * @section sec_examples Examples
+ *
+ * Several examples are located in the examples
+ * directory of the source distribution.
+ *
+ * There is also the
+ * source code of wimlib-imagex, which is complicated but uses most
+ * capabilities of wimlib.
*
* @section sec_basic_wim_handling_concepts Basic WIM handling concepts
*
@@ -88,6 +105,10 @@
* you can make multiple changes to a WIM and commit them all to the underlying
* file in only one overwrite operation, which is more efficient.
*
+ * Note: before calling any other function declared in wimlib.h,
+ * wimlib_global_init() can (and in some cases, must) be called. See its
+ * documentation for more details.
+ *
* @section sec_cleaning_up Cleaning up
*
* After you are done with any ::WIMStruct, you can call wimlib_free() to free