win32sdk/README.win32sdk

   1 $Id: README.win32sdk,v 1.9 2001/10/20 21:31:39 cwolf Exp $
   2 $Name:  $
   3
   4 win32sdk Readme, 13 September, 2001 Chris Wolf
   5 ===========================================================================
   6 This is the win32 SDK for Ogg/Vorbis
   7
   8   This directory, "win32sdk", is not actually part of the SDK as such,
   9   but is a staging area for building the SDK.  The complete SDK ends
  10   up in a directory tree rooted in "sdk", under this directory.
  11   The "sdk" directory tree, once prepared should then be relocatable
  12   and usable by itself.
  13
  14 PREREQUSITES
  15
  16   The SRCROOT environment variable must be set pointing to the
  17   root directory where each of the cvs modules are rooted.  The
  18   cvs modules "ogg", "vorbis" and "win32sdk" (this module) are
  19   required for this build.
  20
  21   if an NMAKE (see below) build is going to be performed, then the
  22   Windows-Script-Host, %SYSTEMROOT%\system32\cscript.exe is
  23   required to export the make and dependency files, otherwise
  24   this step will need to be performed maually.
  25
  26 QUICK SUMMARY
  27
  28   1.) run makesdk.bat
  29   2.) cd sdk\build
  30   3.) run build_all.bat
  31   4.) run run_tests.bat
  32
  33
  34 BUILD USING NMAKE
  35
  36   By default, the scripts will build using msdev workspaces and
  37   project files.  In the case where the sdk may be moved to an
  38   environment which does not have MSVC v6, the build may be
  39   performed using NMAKE.  When the build is performed this way,
  40   makefiles are generated, which should work in older versions
  41   of MSVC.  In order to do this, set the environment
  42   variable "USENMAKE" to "true" (actually, any value will work).
  43
  44   If Windows-script-host, "cscript.exe" is unavailable, then perform
  45   the following manual steps:
  46
  47   1.) Invoke msdev and load "win32sdk\all.dsw"
  48   2.) Perform the following menu navigation:
  49
  50       Project->Export Makefile
  51       When the "Export Makefile(s)" dialog comes up, select all the
  52       checkboxes, then press the "Ok" button.
  53
  54   If there are nmake build problems, try the following three steps
  55   before performing the build again.
  56
  57   1.) run clean_libs_mak.bat
  58   2.) run mkmak.bat
  59   3.) run clean_all.bat
  60
  61 BUILDING
  62
  63   The following steps are optional. They are for building the libraries
  64   in place. The purpose of this step is for libaray development under
  65   win32.
  66
  67   IDE build:
  68
  69   Load the "all.dsw" workspace.  This workspace loads and manages the
  70   the dependent library project files.  To perform a build, from the "build"
  71   menu, select the "build" menu item.  This will build all the dependent
  72   libaries, but not copy them.
  73
  74
  75   N.B. Since unecessary MSVC ancillary files are not present upon initial
  76        checkout, e.g. *.ncb, I've seen MSVC get unhandled exceptions upon
  77        the first startup; subsequent sessions should then work.
  78
  79        Unlike prior versions of MSVC, workspaces (*.dsw) are
  80        used to manage groups of related projects.  There should never
  81        be a reason to directly open project files (*.dsp).  The
  82        workspace keeps track of project dependencies and insures that
  83        each project is build in the correct order.  If you attempt to
  84        open a project (*.dsp) file, then a corresponding workspace (*.dsw)
  85        will be created, which is fine, if you only have a single project,
  86        which is not the case with this module (win32sdk).  So the two
  87        worspaces that are relevant here, are "all.dsw" and
  88        "sdk\build\examples.dsw"
  89
  90
  91 INSTALLING
  92
  93   Once prepared, the tree rooted in "sdk" can be used to build
  94   win32 applications based on Ogg/Vorbis.  See the README in
  95   sdk\build for further information.
  96
  97 OTHER SCRIPTS
  98
  99   clean_all.bat       - performs a make clean for each library target in
 100                         ogg and vorbis.
 101
 102   clean_libs_mak.bat  - deletes the makefiles and their dependecy files
 103                         (*.mak, *.dep) in ogg and vorbis
 104
 105   clean_dist.bat      - restores win32sdk to it's freshly checked out state,
 106
 107   mkmak.bat           - creates makefiles and dependency files in the ogg and
 108                         vorbis modules.  Needs %SYSTEMROOT%\system32\cscript.exe
 109
 110   sdk\build\mkmak.bat - creates makefiles for the example programs