Fixed doxygen warnings about markdown formatting.
authorPhilipp Wiesemann <philipp.wiesemann@arcor.de>
Wed, 24 Feb 2016 21:05:19 +0100
changeset 10092f1949a74dce5
parent 10091 9fccd3acad30
child 10093 7eb2075bdc0b
Fixed doxygen warnings about markdown formatting.
docs/README-android.md
docs/README-macosx.md
docs/README-raspberrypi.md
     1.1 --- a/docs/README-android.md	Mon Feb 22 19:00:22 2016 +0100
     1.2 +++ b/docs/README-android.md	Wed Feb 24 21:05:19 2016 +0100
     1.3 @@ -67,13 +67,13 @@
     1.4      
     1.5  1. Copy the android-project directory wherever you want to keep your projects
     1.6     and rename it to the name of your project.
     1.7 -2. Move or symlink this SDL directory into the <project>/jni directory
     1.8 -3. Edit <project>/jni/src/Android.mk to include your source files
     1.9 +2. Move or symlink this SDL directory into the "<project>/jni" directory
    1.10 +3. Edit "<project>/jni/src/Android.mk" to include your source files
    1.11  4. Run 'ndk-build' (a script provided by the NDK). This compiles the C source
    1.12  
    1.13  If you want to use the Eclipse IDE, skip to the Eclipse section below.
    1.14  
    1.15 -5. Create <project>/local.properties and use that to point to the Android SDK directory, by writing a line with the following form:
    1.16 +5. Create "<project>/local.properties" and use that to point to the Android SDK directory, by writing a line with the following form:
    1.17  
    1.18         sdk.dir=PATH_TO_ANDROID_SDK
    1.19  
    1.20 @@ -121,15 +121,15 @@
    1.21  Instructions:
    1.22  1. Copy the android-project directory wherever you want to keep your projects
    1.23     and rename it to the name of your project.
    1.24 -2. Rename <project>/jni/src/Android_static.mk to <project>/jni/src/Android.mk
    1.25 +2. Rename "<project>/jni/src/Android_static.mk" to "<project>/jni/src/Android.mk"
    1.26     (overwrite the existing one)
    1.27 -3. Edit <project>/jni/src/Android.mk to include your source files
    1.28 +3. Edit "<project>/jni/src/Android.mk" to include your source files
    1.29  4. create and export an environment variable named NDK_MODULE_PATH that points
    1.30     to the parent directory of this SDL directory. e.g.:
    1.31  
    1.32         export NDK_MODULE_PATH="$PWD"/..
    1.33  
    1.34 -5. Edit <project>/src/org/libsdl/app/SDLActivity.java and remove the call to
    1.35 +5. Edit "<project>/src/org/libsdl/app/SDLActivity.java" and remove the call to
    1.36     System.loadLibrary("SDL2").
    1.37  6. Run 'ndk-build' (a script provided by the NDK). This compiles the C source
    1.38  
     2.1 --- a/docs/README-macosx.md	Mon Feb 22 19:00:22 2016 +0100
     2.2 +++ b/docs/README-macosx.md	Wed Feb 24 21:05:19 2016 +0100
     2.3 @@ -96,7 +96,7 @@
     2.4  You should replace EXE_NAME with the name of the executable. APP_NAME is what
     2.5  will be visible to the user in the Finder. Usually it will be the same
     2.6  as EXE_NAME but capitalized. E.g. if EXE_NAME is "testgame" then APP_NAME 
     2.7 -usually is "TestGame". You might also want to use @PACKAGE@ to use the package
     2.8 +usually is "TestGame". You might also want to use `@PACKAGE@` to use the package
     2.9  name as specified in your configure.in file.
    2.10  
    2.11  If your project builds more than one application, you will have to do a bit
     3.1 --- a/docs/README-raspberrypi.md	Mon Feb 22 19:00:22 2016 +0100
     3.2 +++ b/docs/README-raspberrypi.md	Wed Feb 24 21:05:19 2016 +0100
     3.3 @@ -39,7 +39,7 @@
     3.4  
     3.5  You'll also need a Rasbian binary image.
     3.6  Get it from: http://downloads.raspberrypi.org/raspbian_latest 
     3.7 -After unzipping, you'll get file with a name like: <date>-wheezy-raspbian.img
     3.8 +After unzipping, you'll get file with a name like: "<date>-wheezy-raspbian.img"
     3.9  Let's assume the sysroot will be built in /opt/rpi-sysroot.
    3.10  
    3.11      export SYSROOT=/opt/rpi-sysroot