Commit ea86c01a86230a5bb01c69b97875f422fd333651
2016-04-14T21:10:57
Fixed markdown formatting in porting README for doxygen output. The underscores and the newlines for the list were lost before.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
diff --git a/docs/README-porting.md b/docs/README-porting.md
index f13f83b..f06f274 100644
--- a/docs/README-porting.md
+++ b/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.
@@ -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:
@@ -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