premake/README-cygwin.txt
author Sam Lantinga <slouken@libsdl.org>
Wed, 04 Jun 2014 10:56:56 -0700
changeset 8820 0e935d5b193a
parent 7925 f090a47eb7f7
permissions -rwxr-xr-x
Added annotations to help code analysis tools

CR: Bruce Dawson
icculus@7925
     1
There is a script in the Cygwin/build-scripts folder for generating a series of
icculus@7925
     2
GNU makefiles for building the SDL2 project and some parts of its test suite.
icculus@7925
     3
These work similarly to the MinGW makefiles, but the overall Cygwin project has
icculus@7925
     4
significant limitations.
icculus@7925
     5
icculus@7925
     6
The current project will not build correctly. It's experimental and has a lot of
icculus@7925
     7
tweaking needed to be built. It was built successfully once, but it has not been
icculus@7925
     8
maintained in any way.
icculus@7925
     9
icculus@7925
    10
The Cygwin project is limited in that it is not expected to be able to run
icculus@7925
    11
anything visual at all. It is not difficult to enable all of the visual tests
icculus@7925
    12
and support (such as X11 support or OpenGL), but it is not a goal for this
icculus@7925
    13
project. For the complexity of having a compatible desktop environment setup on
icculus@7925
    14
Cygwin, it's assumed that will not be the case for most users of the generated
icculus@7925
    15
Cygwin project. As a result, only the core tests and library are built for
icculus@7925
    16
Cygwin, focusing on things like thread support, file operations, and various
icculus@7925
    17
system queries and information gathering.
icculus@7925
    18
icculus@7925
    19
The Cygwin directory does have automated tests to run through the tests
icculus@7925
    20
supported by Cygwin. It also has separate build scripts for both debug and
icculus@7925
    21
release builds, though this is assuming the GNU make utility is located in the
icculus@7925
    22
user's PATH.
icculus@7925
    23
icculus@7925
    24
The Cygwin project has no outstanding dependencies, since it is designed to be
icculus@7925
    25
mostly minimalistic and just relied on the POSIX functionality provided by
icculus@7925
    26
Cygwin.
icculus@7925
    27
icculus@7925
    28
Like the other projects, you may cleanup the entire directory of any generated
icculus@7925
    29
or built files using the clean script located in Cygwin/build-scripts.