Browse Source

Fixed doxygen warnings about markdown formatting.

Philipp Wiesemann 9 years ago
parent
commit
4011d991e7
3 changed files with 8 additions and 8 deletions
  1. 6 6
      docs/README-android.md
  2. 1 1
      docs/README-macosx.md
  3. 1 1
      docs/README-raspberrypi.md

+ 6 - 6
docs/README-android.md

@@ -67,13 +67,13 @@ For more complex projects, follow these instructions:
     
     
 1. Copy the android-project directory wherever you want to keep your projects
 1. Copy the android-project directory wherever you want to keep your projects
    and rename it to the name of your project.
    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
 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.
 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
        sdk.dir=PATH_TO_ANDROID_SDK
 
 
@@ -121,15 +121,15 @@ This build uses the Android NDK module system.
 Instructions:
 Instructions:
 1. Copy the android-project directory wherever you want to keep your projects
 1. Copy the android-project directory wherever you want to keep your projects
    and rename it to the name of your project.
    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)
    (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
 4. create and export an environment variable named NDK_MODULE_PATH that points
    to the parent directory of this SDL directory. e.g.:
    to the parent directory of this SDL directory. e.g.:
 
 
        export NDK_MODULE_PATH="$PWD"/..
        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").
    System.loadLibrary("SDL2").
 6. Run 'ndk-build' (a script provided by the NDK). This compiles the C source
 6. Run 'ndk-build' (a script provided by the NDK). This compiles the C source
 
 

+ 1 - 1
docs/README-macosx.md

@@ -96,7 +96,7 @@ APP_NAME_bundle: EXE_NAME
 You should replace EXE_NAME with the name of the executable. APP_NAME is what
 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
 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 
 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.
 name as specified in your configure.in file.
 
 
 If your project builds more than one application, you will have to do a bit
 If your project builds more than one application, you will have to do a bit

+ 1 - 1
docs/README-raspberrypi.md

@@ -39,7 +39,7 @@ will be placed in /opt/rpi-tools
 
 
 You'll also need a Rasbian binary image.
 You'll also need a Rasbian binary image.
 Get it from: http://downloads.raspberrypi.org/raspbian_latest 
 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.
 Let's assume the sysroot will be built in /opt/rpi-sysroot.
 
 
     export SYSROOT=/opt/rpi-sysroot
     export SYSROOT=/opt/rpi-sysroot