ao/win32/README.win32

   1 $Id: README.win32,v 1.2 2001/09/05 20:25:20 cwolf Exp $
   2 $Name:  $
   3
   4 Win32 port of libao, September 2001,  Chris Wolf <cwolf@starclass.com>
   5 ===========================================================================
   6 This is the win32 port of the libao library and example program.
   7 It has only been tested using MSVC v6, sp5 on Windows 2000 server, but
   8 should build on other win32 platforms as long as MCVC v6 is used.
   9
  10 BUILDING
  11
  12   Command line build:
  13   Before building, "prebuild.bat" should be called to create
  14   working directories.
  15
  16   The libraries and executables may be built by invoking "build_all.bat".
  17
  18   Note that the makefiles are generated from the IDE, and are thus a
  19   reflection of the workspace and project file states.  It is strongly
  20   recommended to make changes via the IDE and export the makefiles,
  21   rather than tweaking the makefiles directly.
  22
  23   IDE build:
  24   Load the "all.dsw" workspace.  This workspace loads and manages the
  25   the dependent project files.  To perform a build, from the "build"
  26   menu, select the "build" menu item.
  27
  28 INSTALLING
  29   The script "install.bat" can be edited to reflect your environment.
  30   It will copy the DLLs to the designated directory.  Also, it will copy
  31   the plugins to a designated directory.
  32
  33
  34 DIRECTORIES
  35
  36   Debug and release versions of both the static and dynamic (DLL) libraries
  37   will be created in the win32/lib directory.
  38
  39   The debug and release versions of the statically and dynamically linked
  40   versions of the executables will be created in the following directories:
  41
  42   Debug/bin/static
  43   Debug/bin/dynamic
  44   Release/bin/static
  45   Release/bin/dynamic
  46
  47   N.B. In order to execute the dynamically linked executables, the
  48        corresponding DLL's must be in the PATH.  There are two options:
  49
  50        1.) put the fully qualified path of "win32/lib" in the PATH.
  51
  52 LIBRARY NAMING CONVENTIONS
  53
  54   There is an ambiguity with Microsoft's naming convention; a file with
  55   a "*.lib" extension could either be a static library, or a DLL export
  56   library, therefore the following naming convention is adopted to resolve
  57   the ambiguity:
  58
  59   Static Library:      BASENAME_static.lib   e.g. ao_static.lib
  60   DLL export Library:  BASENAME.lib          e.g. ao.lib
  61
  62   In addition, appending "_d" to the basename denotes a debug version of
  63   the library. e.g. ao_static_d.lib, ao_d.dll
  64
  65   The module definition file (ao.def) does not explicitly name
  66   the library, to allow the linker to set the name based on the
  67   type of build.