README.Watcom
changeset 6254 4aa9714c1983
parent 6253 c571220b40f4
child 6255 25bfc0f21c56
     1.1 --- a/README.Watcom	Sun Jan 22 17:33:44 2012 -0500
     1.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.3 @@ -1,139 +0,0 @@
     1.4 -
     1.5 -Using SDL 1.3 under Windows with the OpenWatcom compiler
     1.6 -
     1.7 -====================================================
     1.8 -
     1.9 -Prerequisites
    1.10 --------------
    1.11 -
    1.12 -I have done the port under Windows XP Professional with SP2 installed.
    1.13 -Windows 2000 should also be working. I'm not so sure about ancient Windows NT,
    1.14 -since only DirectX 3 is available there. Building should be possible,
    1.15 -but running the compiled applications will probalbly fail with
    1.16 -SDL_VIDEODRIVER=directx. The windib driver should work, though.
    1.17 -
    1.18 -To compile and use the SDL with Open Watcom you will need the following:
    1.19 -- Open Watcom compiler. I used version 1.8. The environment variables
    1.20 -  PATH, WATCOM and INCLUDE need to be set appropriately - please consult
    1.21 -  the OpenWatcom documentation and instructions given during the
    1.22 -  installation of the compiler.
    1.23 -  My setup looks like this in owvars.bat:
    1.24 -    set WATCOM=C:\dev\ow18
    1.25 -    set INCLUDE=%WATCOM%\h;%WATCOM%\h\nt
    1.26 -    set PATH=%PATH%;%WATCOM%\binnt;%WATCOM%\binw
    1.27 -- A recent DirectX SDK. The library needs D3d9.h so at leat the
    1.28 -  directx 9 sdk is to be used. I used DirectX 10 SDK from August 2009
    1.29 -  taken directly from the microsoft site.
    1.30 -- The SDL 1.3 sources from Subversion
    1.31 -- The file Watcom-Win32.zip (now available in Subversion)
    1.32 -
    1.33 -
    1.34 -Building the Library
    1.35 ---------------------
    1.36 -
    1.37 -1) In the SDL base directory extract the archive Watcom-Win32.zip. This
    1.38 -   creates a subdirectory named 'watcom'.
    1.39 -2) The makefile expects the environment variable DXDIR to be set to the
    1.40 -   base directory of a DirectX SDK. I have tried the August 2009
    1.41 -   DirectX SDK from Microsoft
    1.42 -   You can also edit the makefile directly and hard code your path to
    1.43 -   the SDK on your system.
    1.44 -   I have this in my setup:
    1.45 -     set DXDIR=..\dx10
    1.46 -3) Enter the watcom directory and run
    1.47 -     wmake sdl
    1.48 -4) All tests from the test directory are working and can be built by
    1.49 -   running
    1.50 -     wmake tests
    1.51 -
    1.52 -Notes:
    1.53 -
    1.54 - The makefile offers some options to tweak the way the library is built.
    1.55 - You have at your disposal the option to build a static (default)
    1.56 - library, or a DLL (with tgt=dll). You can also choose whether to build
    1.57 - a Release (default) or a Debug version (with build=debug) of the tests
    1.58 - and library. Please consult the usage comment at the top of the
    1.59 - makefile for usage instructions.
    1.60 -
    1.61 - If you specify a test target (i.e. 'wmake tests' for all tests, or
    1.62 - selected targets like 'wmake testgl testvidinfo testoverlay2'), the
    1.63 - tests are always freshly compiled and linked. This is done to
    1.64 - minimise hassle when switching between library versions (static vs.
    1.65 - DLL), because they require subtly different options.
    1.66 - Also, the test executables are put directly into the test directory,
    1.67 - so they can find their data files. The clean target of the makefile
    1.68 - removes the test executables and the SDL.dll file from the test
    1.69 - directory.
    1.70 -
    1.71 - To use the library in your own projects with Open Watcom, you can use
    1.72 - the way the tests are built as base of your own build environment.
    1.73 -
    1.74 - The library can also be built with the stack calling convention of the
    1.75 - compiler (-6s instead of -6r).
    1.76 -
    1.77 -Test applications
    1.78 ------------------
    1.79 -$FixME: which test works ? which one compiles ?
    1.80 -
    1.81 -I've tried to make all tests work. The following table gives an overview
    1.82 -of the current status.
    1.83 -
    1.84 - Testname        Status
    1.85 -~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    1.86 -checkkeys       +
    1.87 -graywin         +
    1.88 -loopwave        +
    1.89 -testalpha       +
    1.90 -testbitmap      +
    1.91 -testdyngl       +
    1.92 -testerror       +
    1.93 -testfile        +
    1.94 -testgamma       +
    1.95 -testgl          +
    1.96 -testhread       +
    1.97 -testiconv       - (all failed)
    1.98 -testkeys        +
    1.99 -testlock        +
   1.100 -testoverlay     + (needs 'set SDL_VIDEODRIVER=directx')
   1.101 -testoverlay2    + (needs 'set SDL_VIDEODRIVER=directx')
   1.102 -testpalette     +
   1.103 -testplatform    +
   1.104 -testsem         +
   1.105 -testsprite      +
   1.106 -testtimer       +
   1.107 -testver         +
   1.108 -testvidinfo     +
   1.109 -testwin         ? (fading doesn't seem right)
   1.110 -testwm          +
   1.111 -torturethread   +
   1.112 -testcdrom       +
   1.113 -testjoystick    not tested
   1.114 -threadwin       +
   1.115 -testcursor      +
   1.116 -
   1.117 -
   1.118 -TODO
   1.119 -----
   1.120 -
   1.121 -There is room for further improvement:
   1.122 -- Test joystick functionality.
   1.123 -- Investigate fading issue in 'testwin' test.
   1.124 -- Fix the UTF-8 support.
   1.125 -- Adapt the makefile/object file list to support more target systems
   1.126 -- Use "#pragma aux" syntax for the CPU info functions.
   1.127 -
   1.128 -
   1.129 -Questions and Comments
   1.130 -----------------------
   1.131 -
   1.132 -Please direct any questions or comments to me:
   1.133 -
   1.134 -        ow_sdl [at] digitalfantasy [dot] it
   1.135 -
   1.136 -The original porting to the open watcom compiler was made by
   1.137 -Marc Peter <mailto:macpete@gmx.de>
   1.138 -
   1.139 -   Happy Coding!
   1.140 -
   1.141 -   Daniele Forghieri
   1.142 -