README.Porting
author Ozkan Sezer <sezeroz@gmail.com>
Sun, 01 Jul 2018 09:50:47 +0300
branchSDL-1.2
changeset 12050 f68904a749c9
parent 1484 b2b476a4a73c
child 1946 103760c3a5dc
permissions -rw-r--r--
make sure SDL_vsnprintf() nul terminates if it is using _vsnprintf

(bug #3769: backported commit 5e1341f8c467 for windows and watcom.)
     1 
     2 * Porting To A New Platform
     3 
     4   The first thing you have to do when porting to a new platform, is look at
     5 include/SDL_platform.h and create an entry there for your operating system.
     6 The standard format is __PLATFORM__, where PLATFORM is the name of the OS.
     7 Ideally SDL_platform.h will be able to auto-detect the system it's building
     8 on based on C preprocessor symbols.
     9 
    10 There are two basic ways of building SDL at the moment:
    11 
    12 1. The "UNIX" way:  ./configure; make; make install
    13 
    14    If you have a GNUish system, then you might try this.  Edit configure.in,
    15    take a look at the large section labelled:
    16 	"Set up the configuration based on the target platform!"
    17    Add a section for your platform, and then re-run autogen.sh and build!
    18 
    19 2. Using an IDE:
    20 
    21    If you're using an IDE or other non-configure build system, you'll probably
    22    want to create a custom SDL_config.h for your platform.  Edit SDL_config.h,
    23    add a section for your platform, and create a custom SDL_config_{platform}.h,
    24    based on SDL_config.h.minimal and SDL_config.h.in
    25 
    26    Add the top level include directory to the header search path, and then add
    27    the following sources to the project:
    28 	src/*.c
    29 	src/audio/*.c
    30 	src/cdrom/*.c
    31 	src/cpuinfo/*.c
    32 	src/events/*.c
    33 	src/file/*.c
    34 	src/joystick/*.c
    35 	src/stdlib/*.c
    36 	src/thread/*.c
    37 	src/timer/*.c
    38 	src/video/*.c
    39 	src/audio/disk/*.c
    40 	src/video/dummy/*.c
    41 	src/joystick/dummy/*.c
    42 	src/cdrom/dummy/*.c
    43 	src/thread/generic/*.c
    44 	src/timer/dummy/*.c
    45 	src/loadso/dummy/*.c
    46 
    47 
    48 Once you have a working library without any drivers, you can go back to each
    49 of the major subsystems and start implementing drivers for your platform.
    50 
    51 If you have any questions, don't hesitate to ask on the SDL mailing list:
    52 	http://www.libsdl.org/mailing-list.php
    53 
    54 Enjoy!
    55 	Sam Lantinga				(slouken@libsdl.org)
    56