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