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