From 0adc558a1081d1ee43cfbc875f23df0d9fcc8f66 Mon Sep 17 00:00:00 2001 From: Johan Euphrosine Date: Fri, 7 Aug 2015 18:24:43 +0900 Subject: [PATCH] fix README typos --- Teapot/README.md | 2 +- bitmap-plasma/README.md | 2 +- endless-tunnel/README.md | 6 ++-- hello-gl2/README.md | 2 +- native-activity/README.md | 2 +- native-audio/README.md | 2 +- native-media/README.md | 2 +- native-plasma/README.md | 2 +- san-angeles/README.md | 4 +-- sensor-circle/README.md | 60 --------------------------------------- 10 files changed, 12 insertions(+), 72 deletions(-) delete mode 100644 sensor-circle/README.md diff --git a/Teapot/README.md b/Teapot/README.md index 5da5472ec..946356df8 100644 --- a/Teapot/README.md +++ b/Teapot/README.md @@ -1,6 +1,6 @@ Teapot ====== -Teapot is an Android C++ sample that draw a Teapot mesh using GLES 2.0 API and [NativeActivity](http://developer.android.com/reference/android/app/NativeActivity.html). +Teapot is an Android C++ sample that draws a Teapot mesh using GLES 2.0 API and [NativeActivity](http://developer.android.com/reference/android/app/NativeActivity.html). Pre-requisites -------------- diff --git a/bitmap-plasma/README.md b/bitmap-plasma/README.md index 4db8bf901..76570cc71 100644 --- a/bitmap-plasma/README.md +++ b/bitmap-plasma/README.md @@ -1,6 +1,6 @@ Bitmap Plasma ============= -Bitmap Plasma is an Android sample that uses JNI to renders a plasma effect in a Android [Bitmap](http://developer.android.com/reference/android/graphics/Bitmap.html) from C code. +Bitmap Plasma is an Android sample that uses JNI to render a plasma effect in an Android [Bitmap](http://developer.android.com/reference/android/graphics/Bitmap.html) from C code. Pre-requisites -------------- diff --git a/endless-tunnel/README.md b/endless-tunnel/README.md index 3c6ec3341..d165b4564 100644 --- a/endless-tunnel/README.md +++ b/endless-tunnel/README.md @@ -3,7 +3,7 @@ Endless Tunnel Endless Tunnel is a sample game that shows how to: - use the Android Studio C++ support - implement a game using Android native glue -- implement joystick support, including robust DPAD navigation for no-touch screens +- implement joystick support, including robust DPAD navigation for non-touch screens It is NOT the goal of this sample to show the best way to write the game logic, load resources, etc. The game itself was intentionally @@ -47,7 +47,7 @@ Most of this code was written by [Bruno Oliveira](https://plus.google.com/+Bruno Walkthrough ----------- -Source code are under app, it only contains C++ code, which is +Source code is under app, it only contains C++ code, which is sitting at its default location (same as for other samples) at app/jni. @@ -77,7 +77,7 @@ scene. Input arrives by way of the engine_handle_input function, which does some basic input classification and delivers the input to -the scene manager. Incidentally, here we also synthethise DPAD events based +the scene manager. Incidentally, here we also synthesise DPAD events based on the joystick hat axes (many game controllers generate hat events when you press the directional pad), because that way we can use that directional pad to drive UI navigation in the main screen. diff --git a/hello-gl2/README.md b/hello-gl2/README.md index fde5ee746..3d6c4e1cb 100644 --- a/hello-gl2/README.md +++ b/hello-gl2/README.md @@ -1,6 +1,6 @@ Hello GL2 ========= -Hello GL2 is an Android C++ sample that draw a triangle using GLES 2.0 API. +Hello GL2 is an Android C++ sample that draws a triangle using GLES 2.0 API. It uses JNI to do the rendering in C++ over a [GLSurfaceView](http://developer.android.com/reference/android/opengl/GLSurfaceView.html) diff --git a/native-activity/README.md b/native-activity/README.md index fd42a6380..bfb2fcd7a 100644 --- a/native-activity/README.md +++ b/native-activity/README.md @@ -1,6 +1,6 @@ Native Activity =============== -Native Activity is an Android sample that initializes a GLES 2.0 context and read accelerometer value from C code using [Native Activity](http://developer.android.com/reference/android/app/NativeActivity.html). +Native Activity is an Android sample that initializes a GLES 2.0 context and reads accelerometer data from C code using [Native Activity](http://developer.android.com/reference/android/app/NativeActivity.html). Pre-requisites -------------- diff --git a/native-audio/README.md b/native-audio/README.md index bb7a7267e..b7a4272a0 100644 --- a/native-audio/README.md +++ b/native-audio/README.md @@ -1,6 +1,6 @@ Native Audio ============ -Native Audio is an Android sample that play and record sounds with the C++ OpenSLES API using JNI. +Native Audio is an Android sample that plays and records sounds with the C++ OpenSLES API using JNI. Pre-requisites -------------- diff --git a/native-media/README.md b/native-media/README.md index 85454ceed..4c410faab 100644 --- a/native-media/README.md +++ b/native-media/README.md @@ -1,6 +1,6 @@ Native Media ============ -Native Media is an Android sample that uses OpenMAX AL to a play video. +Native Media is an Android sample that uses OpenMAX AL to play a video. Note: This sample requires an MPEG-2 Transport Stream file to be placed in /sdcard/NativeMedia.ts and encoded as: diff --git a/native-plasma/README.md b/native-plasma/README.md index 534568b49..3d1238b51 100644 --- a/native-plasma/README.md +++ b/native-plasma/README.md @@ -1,6 +1,6 @@ Native Plasma ============= -Native Plasma is an Android sample that render a plasma effect in a Bitmap from C code using [Native Activity](http://developer.android.com/reference/android/app/NativeActivity.html). +Native Plasma is an Android sample that renders a plasma effect in a Bitmap from C code using [Native Activity](http://developer.android.com/reference/android/app/NativeActivity.html). Pre-requisites -------------- diff --git a/san-angeles/README.md b/san-angeles/README.md index e0c173dc5..ad9bad4ba 100644 --- a/san-angeles/README.md +++ b/san-angeles/README.md @@ -1,8 +1,8 @@ San Angeles =========== -San Angeles is a Android port of a demo that uses GLES C/API to render a procedural scene. +San Angeles is an Android port of a demo that uses GLES C/API to render a procedural scene. -See the original [README](app/src/main/jni/README.txt) more details about the original GLES port. +See the original [README](app/src/main/jni/README.txt) for more details about the original GLES port. Pre-requisites -------------- diff --git a/sensor-circle/README.md b/sensor-circle/README.md deleted file mode 100644 index 6a6271507..000000000 --- a/sensor-circle/README.md +++ /dev/null @@ -1,60 +0,0 @@ -Sensor-Graph -============ -Sensor graph is a C++ Android sample that read current accelerometer values and draw them using OpenGL. - -It demonstrate usage of the following Native C++ API: -- [Sensors](http://developer.android.com/ndk/reference/group___sensor.html) -- [Assets](http://developer.android.com/ndk/reference/group___asset.html) - -Pre-requisites --------------- - -- Android Studio 1.3 with [NDK](https://developer.android.com/ndk/) bundle. - -Getting Started ---------------- - -1. [Download Android Studio](http://developer.android.com/sdk/index.html) -1. Launch Android Studio. -1. Open `android-ndk/sensor-graph` sample. -1. Open *File/Project Structure...* - 1. Click *Download* or *Select NDK location*. -1. Click *Tools/Android/Sync Project with Gradle Files*. -1. Click *Run/Run 'app'*. - -Screenshots ------------ - -![screenshot](screenshot.png) - -Support -------- - -If you've found an error in these samples, please [file an issue](https://github.com/googlesamples/android-ndk/issues/new). - -Patches are encouraged, and may be submitted by [forking this project](https://github.com/googlesamples/android-ndk/fork) and -submitting a pull request through GitHub. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more details. - -- [Stack Overflow](http://stackoverflow.com/questions/tagged/android-ndk) -- [Google+ Community](https://plus.google.com/communities/105153134372062985968) -- [Android Tools Feedbacks](http://tools.android.com/feedback) - -License -------- - -Copyright 2015 Google, Inc. - -Licensed to the Apache Software Foundation (ASF) under one or more contributor -license agreements. See the NOTICE file distributed with this work for -additional information regarding copyright ownership. The ASF licenses this -file to you under the Apache License, Version 2.0 (the "License"); you may not -use this file except in compliance with the License. You may obtain a copy of -the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -License for the specific language governing permissions and limitations under -the License.