Fixed doxygen warnings about markdown formatting.
authorPhilipp Wiesemann <philipp.wiesemann@arcor.de>
Wed, 24 Feb 2016 21:05:19 +0100
changeset 10092 f1949a74dce5
parent 10091 9fccd3acad30
child 10093 7eb2075bdc0b
Fixed doxygen warnings about markdown formatting.
docs/README-android.md
docs/README-macosx.md
docs/README-raspberrypi.md
--- a/docs/README-android.md	Mon Feb 22 19:00:22 2016 +0100
+++ b/docs/README-android.md	Wed Feb 24 21:05:19 2016 +0100
@@ -67,13 +67,13 @@
     
 1. Copy the android-project directory wherever you want to keep your projects
    and rename it to the name of your project.
-2. Move or symlink this SDL directory into the <project>/jni directory
-3. Edit <project>/jni/src/Android.mk to include your source files
+2. Move or symlink this SDL directory into the "<project>/jni" directory
+3. Edit "<project>/jni/src/Android.mk" to include your source files
 4. Run 'ndk-build' (a script provided by the NDK). This compiles the C source
 
 If you want to use the Eclipse IDE, skip to the Eclipse section below.
 
-5. Create <project>/local.properties and use that to point to the Android SDK directory, by writing a line with the following form:
+5. Create "<project>/local.properties" and use that to point to the Android SDK directory, by writing a line with the following form:
 
        sdk.dir=PATH_TO_ANDROID_SDK
 
@@ -121,15 +121,15 @@
 Instructions:
 1. Copy the android-project directory wherever you want to keep your projects
    and rename it to the name of your project.
-2. Rename <project>/jni/src/Android_static.mk to <project>/jni/src/Android.mk
+2. Rename "<project>/jni/src/Android_static.mk" to "<project>/jni/src/Android.mk"
    (overwrite the existing one)
-3. Edit <project>/jni/src/Android.mk to include your source files
+3. Edit "<project>/jni/src/Android.mk" to include your source files
 4. create and export an environment variable named NDK_MODULE_PATH that points
    to the parent directory of this SDL directory. e.g.:
 
        export NDK_MODULE_PATH="$PWD"/..
 
-5. Edit <project>/src/org/libsdl/app/SDLActivity.java and remove the call to
+5. Edit "<project>/src/org/libsdl/app/SDLActivity.java" and remove the call to
    System.loadLibrary("SDL2").
 6. Run 'ndk-build' (a script provided by the NDK). This compiles the C source
 
--- a/docs/README-macosx.md	Mon Feb 22 19:00:22 2016 +0100
+++ b/docs/README-macosx.md	Wed Feb 24 21:05:19 2016 +0100
@@ -96,7 +96,7 @@
 You should replace EXE_NAME with the name of the executable. APP_NAME is what
 will be visible to the user in the Finder. Usually it will be the same
 as EXE_NAME but capitalized. E.g. if EXE_NAME is "testgame" then APP_NAME 
-usually is "TestGame". You might also want to use @PACKAGE@ to use the package
+usually is "TestGame". You might also want to use `@PACKAGE@` to use the package
 name as specified in your configure.in file.
 
 If your project builds more than one application, you will have to do a bit
--- a/docs/README-raspberrypi.md	Mon Feb 22 19:00:22 2016 +0100
+++ b/docs/README-raspberrypi.md	Wed Feb 24 21:05:19 2016 +0100
@@ -39,7 +39,7 @@
 
 You'll also need a Rasbian binary image.
 Get it from: http://downloads.raspberrypi.org/raspbian_latest 
-After unzipping, you'll get file with a name like: <date>-wheezy-raspbian.img
+After unzipping, you'll get file with a name like: "<date>-wheezy-raspbian.img"
 Let's assume the sysroot will be built in /opt/rpi-sysroot.
 
     export SYSROOT=/opt/rpi-sysroot