[sdl_omap.git] / README.Porting


* Porting To A New Platform

  The first thing you have to do when porting to a new platform, is look at
include/SDL_platform.h and create an entry there for your operating system.
The standard format is __PLATFORM__, where PLATFORM is the name of the OS.
Ideally SDL_platform.h will be able to auto-detect the system it's building
on based on C preprocessor symbols.

There are two basic ways of building SDL at the moment:

1. The "UNIX" way:  ./configure; make; make install

   If you have a GNUish system, then you might try this.  Edit configure.in,
   take a look at the large section labelled:
	"Set up the configuration based on the target platform!"
   Add a section for your platform, and then re-run autogen.sh and build!

2. Using an IDE:

   If you're using an IDE or other non-configure build system, you'll probably
   want to create a custom SDL_config.h for your platform.  Edit SDL_config.h,
   add a section for your platform, and create a custom SDL_config_{platform}.h,
   based on SDL_config.h.minimal and SDL_config.h.in

   Add the top level include directory to the header search path, and then add
   the following sources to the project:
	src/*.c
	src/audio/*.c
	src/cdrom/*.c
	src/cpuinfo/*.c
	src/events/*.c
	src/file/*.c
	src/joystick/*.c
	src/stdlib/*.c
	src/thread/*.c
	src/timer/*.c
	src/video/*.c
	src/audio/disk/*.c
	src/video/dummy/*.c
	src/joystick/dummy/*.c
	src/cdrom/dummy/*.c
	src/thread/generic/*.c
	src/timer/dummy/*.c
	src/loadso/dummy/*.c


Once you have a working library without any drivers, you can go back to each
of the major subsystems and start implementing drivers for your platform.

If you have any questions, don't hesitate to ask on the SDL mailing list:
	http://www.libsdl.org/mailing-list.php

Enjoy!
	Sam Lantinga				(slouken@libsdl.org)
Commit	Line	Data
e14743d1	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