Skip to content

Commit

Permalink
Fixed markdown formatting in porting README for doxygen output.
Browse files Browse the repository at this point in the history
The underscores and the newlines for the list were lost before.
  • Loading branch information
philippwiesemann committed Apr 14, 2016
1 parent b53007b commit ea86c01
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/README-porting.md
@@ -1,11 +1,11 @@
Porting
=======
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.
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.

Expand All @@ -15,7 +15,9 @@ There are two basic ways of building SDL at the moment:

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 host platform!"

Add a section for your platform, and then re-run autogen.sh and build!

2. Using an IDE:
Expand All @@ -27,6 +29,7 @@ There are two basic ways of building SDL at the moment:

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
Expand Down

0 comments on commit ea86c01

Please sign in to comment.