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