mo-better timed text

[asdcplib.git] / win32 / README.txt

diff --git a/win32/README.txt b/win32/README.txt
index 01644c30679adc624c2f81d49e6b4fc2caf50465..850624c8e273e731c0f0f33d3f721690a46099a5 100755 (executable)
--- a/win32/README.txt
+++ b/win32/README.txt
@@ -1,2 +1,53 @@
+I. INTRODUCTION\r
+===============\r
+\r
 Hello, and welcome to the Windows build instructions for asdcplib.\r
 \r
+\r
+II. DEPENDENCIES\r
+================\r
+\r
+First, you'll need Microsoft's Visual Studio 2005 or later. A heavyweight edition isn't needed;\r
+the freely downloadable Express edition works fine.\r
+\r
+Next, you'll need an OpenSSL distribution. The absolute, bare minimum needed is 0.9.7. However,\r
+if this will be used in conjunction with CineCert's other software, the later 0.9.8b\r
+is needed. That said, the latest revision of OpenSSL as of this writing (0.9.8j) works great.\r
+Extract and build in the directory of your choice.\r
+\r
+For optional XML parsing support, you'll need to use Xerces-C++ 2.7 or 2.8 (3.0 isn't yet\r
+supported) or Expat 2.0.1 (supported in previous versions of asdcplib). If you'll be using this\r
+software in conjuction with CineCert's other software, the use of Xerces-C++ is required. As\r
+with OpenSSL above, if you need/desire XML parsing, extract the source package and build in a\r
+directory of your choice.\r
+\r
+\r
+III. BUILDING\r
+=============\r
+\r
+There's a build option that changes the behavior of UUID generation. If ENABLE_RANDOM_UUID is\r
+set at build, then mixed-case UUID generation will be enabled if (and only if) the environment\r
+variable KM_USE_RANDOM_UUID is set during runtime.\r
+\r
+Open a command prompt in which the VS build tools are available on the command line (e.g., the\r
+"Visual Studio command prompt"). The nmake invocation follows this form:\r
+C:\>nmake WITH_OPENSSL=<OpenSSL directory> [WITH_XERCES=<Xerces directory>|\r
+       WITH_XML_PARSER=<Expat directory>] [ENABLE_RANDOM_UUID=1] /f Makefile.mak\r
+\r
+On our Windows development machine, the invocation with XML parsing by Xerces-C++ is as such:\r
+C:\Program Files\asdcplib\win32>nmake WITH_OPENSSL="c:\Program Files\openssl-0.9.8j"\r
+       WITH_XERCES="C:\Program Files\xerces-c_2_8_0-x86-windows-vc_8_0" /f Makefile.mak\r
+\r
+With XML parsing by Expat and random UUID generation enabled:\r
+C:\Program Files\asdcplib\win32>nmake WITH_OPENSSL="c:\Program Files\openssl-0.9.8j"\r
+       WITH_XML_PARSER="C:\Program Files\Expat 2.0.1" ENABLE_RANDOM_UUID=1 /f Makefile.mak\r
+\r
+Without XML parsing:\r
+C:\Program Files\asdcplib\win32>nmake WITH_OPENSSL="c:\Program Files\openssl-0.9.8j"\r
+       /f Makefile.mak\r
+\r
+\r
+IV. CONCLUSION\r
+==============\r
+\r
+For answers to questions, please send a message to <asdcplib@cinecert.com>.\r