README.Porting
author Sam Lantinga <slouken@libsdl.org>
Sun, 10 Mar 2013 09:03:38 -0700
changeset 6987 7084af936d82
parent 1946 103760c3a5dc
permissions -rw-r--r--
Fixed bug 1748 - Patch for errors and mistakes in SDL 2 README files. Philipp Wiesemann SDL's README files seem to contain multiple errors and mistakes. I attached a patch with changes and updates. README: * removed Windows CE because no more supported README-SDL.txt: * corrected spelling mistake README.DirectFB: * corrected spelling mistakes README.MacOSX: * corrected spelling mistakes README.Platforms: * changed Android version to match AndroidManifest.xml README.Porting: * added missing directories from list * removed cdrom directories from list README.android: * updated required NDK revision * add project.properties to list * changed lower limit for to android-10 and removed upper * added a statement why older devices not supported * added correct dates to statements about OpenGL ES * added info about Google's device numbers and date * corrected spelling mistakes README.gesture: * corrected spelling mistakes README.pandora: * corrected spelling mistake README.touch: * changed that values are no in range 0..1 * updated the names of some functions * updated the notes about usage * corrected spelling mistakes * added info that API changed near original author contact


* 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/atomic/*.c
	src/audio/*.c
	src/cpuinfo/*.c
	src/events/*.c
	src/file/*.c
	src/haptic/*.c
	src/joystick/*.c
	src/power/*.c
	src/render/*.c
	src/stdlib/*.c
	src/thread/*.c
	src/timer/*.c
	src/video/*.c
	src/audio/disk/*.c
	src/audio/dummy/*.c
	src/video/dummy/*.c
	src/haptic/dummy/*.c
	src/joystick/dummy/*.c
	src/main/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)