From 4011d991e79e8a6e20eaf397613631f19ae693cd Mon Sep 17 00:00:00 2001 From: Philipp Wiesemann Date: Wed, 24 Feb 2016 21:05:19 +0100 Subject: [PATCH] Fixed doxygen warnings about markdown formatting. --- docs/README-android.md | 12 ++++++------ docs/README-macosx.md | 2 +- docs/README-raspberrypi.md | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/README-android.md b/docs/README-android.md index a4b38210fe1af..bf7b1cdc6b2d9 100644 --- a/docs/README-android.md +++ b/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 and rename it to the name of your project. -2. Move or symlink this SDL directory into the /jni directory -3. Edit /jni/src/Android.mk to include your source files +2. Move or symlink this SDL directory into the "/jni" directory +3. Edit "/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 /local.properties and use that to point to the Android SDK directory, by writing a line with the following form: +5. Create "/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 @@ This build uses the Android NDK module system. 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 /jni/src/Android_static.mk to /jni/src/Android.mk +2. Rename "/jni/src/Android_static.mk" to "/jni/src/Android.mk" (overwrite the existing one) -3. Edit /jni/src/Android.mk to include your source files +3. Edit "/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 /src/org/libsdl/app/SDLActivity.java and remove the call to +5. Edit "/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 diff --git a/docs/README-macosx.md b/docs/README-macosx.md index 747e1e6067b27..693e1947bf384 100644 --- a/docs/README-macosx.md +++ b/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 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 diff --git a/docs/README-raspberrypi.md b/docs/README-raspberrypi.md index ade3c81c631bc..6b6b785f20b49 100644 --- a/docs/README-raspberrypi.md +++ b/docs/README-raspberrypi.md @@ -39,7 +39,7 @@ will be placed in /opt/rpi-tools 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: -wheezy-raspbian.img +After unzipping, you'll get file with a name like: "-wheezy-raspbian.img" Let's assume the sysroot will be built in /opt/rpi-sysroot. export SYSROOT=/opt/rpi-sysroot