Skip to content

Commit aa52693

Browse files
committed
Remove obsolete, duplicate, and useless docs.
License text, setup instructions, and support info do not need to be duplicated into every README, since they're already in the top-level README. They were originally in each sample because the samples used to each be separate Android Studio projects with different requirements that could be checkout out independently in Android Studio. This is no longer the case. Most of the docs also included text along the lines of "This sample uses the new Android Studio with CMake support", which hasn't been new since 2015, so doesn't really need to be said. The prerequisites were mostly not true. Android Studio is not required for any of this. Cloning the repo and running `./gradlew build` is sufficient to build all the samples. They also were not being kept up-to-date at all, since they mostly said "Android Studio 2.2 or newer", which was definitely not true. I'm not what the oldest version of Android Studio that will work here is, but I don't actually test anything but the latest so claiming anything otherwise is just misleading. I haven't pruned or edited any of the real content of the docs. I'm sure there are plenty of edits to be made there and a lot of expansion to do, but those changes will be less mechanical and will happen separately.
1 parent 59791f2 commit aa52693

File tree

20 files changed

+2
-898
lines changed

20 files changed

+2
-898
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ For questions about using the NDK or the platform APIs, you can ask on:
146146

147147
## License
148148

149-
Copyright 2018 The Android Open Source Project, Inc.
149+
Copyright 2015 The Android Open Source Project, Inc.
150150

151151
Licensed to the Apache Software Foundation (ASF) under one or more contributor
152152
license agreements. See the NOTICE file distributed with this work for

audio-echo/README.md

Lines changed: 1 addition & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -6,36 +6,13 @@ there is a optimized audio path that is tuned up for low latency purpose. The
66
sample creates player/recorder to work in this highly optimized audio
77
path(sometimes called native audio path,
88
[low latency path](http://stackoverflow.com/questions/14842803/low-latency-audio-playback-on-android?rq=1),
9-
or fast audio path). The application is validated against the following
10-
configurations:
11-
12-
- Android L AndroidOne
13-
- Android M Nexus 5, Nexus 9
14-
15-
This sample uses the new Android Studio with CMake support, and shows how to use
16-
shared stl lib with android studio version 2.2.0, see CMakeLists.txt for details
9+
or fast audio path).
1710

1811
***Note that OpenSL ES is
1912
[deprecated from Android 11](https://developer.android.com/preview/features#deprecate-opensl),
2013
developers are recommended to use [Oboe](https://github.com/google/oboe) library
2114
instead.***
2215

23-
## Pre-requisites
24-
25-
- Android Studio 2.2+ with [NDK](https://developer.android.com/ndk/) bundle.
26-
27-
## Getting Started
28-
29-
1. [Download Android Studio](http://developer.android.com/sdk/index.html)
30-
1. Launch Android Studio.
31-
1. Open the sample directory.
32-
1. Open *File/Project Structure...*
33-
34-
- Click *Download* or *Select NDK location*.
35-
36-
1. Click *Tools/Android/Sync Project with Gradle Files*.
37-
1. Click *Run/Run 'app'*.
38-
3916
## Usage
4017

4118
App will capture audio from android devices and playback on the same device; the
@@ -98,40 +75,3 @@ A couple of knobs in the code for lower latency purpose:
9875
playback audio experience. The app capture and playback on the same device
9976
\[most of times the same chip\], capture and playback clocks are assumed
10077
synchronized naturally \[so we are not dealing with it\]
101-
102-
## Credits
103-
104-
- The sample is greatly inspired by native-audio sample
105-
- Don Turner @ Google for the helping of low latency path
106-
- Ian Ni-Lewis @ Google for producer/consumer queue and many others
107-
108-
## Support
109-
110-
If you've found an error in these samples, please
111-
[file an issue](https://github.com/googlesamples/android-ndk/issues/new).
112-
113-
Patches are encouraged, and may be submitted by
114-
[forking this project](https://github.com/googlesamples/android-ndk/fork) and
115-
submitting a pull request through GitHub. Please see
116-
[CONTRIBUTING.md](../CONTRIBUTING.md) for more details.
117-
118-
- [Stack Overflow](http://stackoverflow.com/questions/tagged/android-ndk)
119-
- [Android Tools Feedbacks](http://tools.android.com/feedback)
120-
121-
## License
122-
123-
Copyright 2015 Google, Inc.
124-
125-
Licensed to the Apache Software Foundation (ASF) under one or more contributor
126-
license agreements. See the NOTICE file distributed with this work for
127-
additional information regarding copyright ownership. The ASF licenses this file
128-
to you under the Apache License, Version 2.0 (the "License"); you may not use
129-
this file except in compliance with the License. You may obtain a copy of the
130-
License at
131-
132-
http://www.apache.org/licenses/LICENSE-2.0
133-
134-
Unless required by applicable law or agreed to in writing, software distributed
135-
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
136-
CONDITIONS OF ANY KIND, either express or implied. See the License for the
137-
specific language governing permissions and limitations under the License.

bitmap-plasma/README.md

Lines changed: 0 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -5,57 +5,6 @@ Android
55
[Bitmap](http://developer.android.com/reference/android/graphics/Bitmap.html)
66
from C code.
77

8-
This sample uses the new
9-
[Android Studio CMake plugin](http://tools.android.com/tech-docs/external-c-builds)
10-
with C++ support.
11-
12-
## Pre-requisites
13-
14-
- Android Studio 2.2+ with [NDK](https://developer.android.com/ndk/) bundle.
15-
16-
## Getting Started
17-
18-
1. [Download Android Studio](http://developer.android.com/sdk/index.html)
19-
1. Launch Android Studio.
20-
1. Open the sample directory.
21-
1. Open *File/Project Structure...*
22-
23-
- Click *Download* or *Select NDK location*.
24-
25-
1. Click *Tools/Android/Sync Project with Gradle Files*.
26-
1. Click *Run/Run 'app'*.
27-
288
## Screenshots
299

3010
![screenshot](screenshot.png)
31-
32-
## Support
33-
34-
If you've found an error in these samples, please
35-
[file an issue](https://github.com/googlesamples/android-ndk/issues/new).
36-
37-
Patches are encouraged, and may be submitted by
38-
[forking this project](https://github.com/googlesamples/android-ndk/fork) and
39-
submitting a pull request through GitHub. Please see
40-
[CONTRIBUTING.md](../CONTRIBUTING.md) for more details.
41-
42-
- [Stack Overflow](http://stackoverflow.com/questions/tagged/android-ndk)
43-
- [Android Tools Feedbacks](http://tools.android.com/feedback)
44-
45-
## License
46-
47-
Copyright 2015 Google, Inc.
48-
49-
Licensed to the Apache Software Foundation (ASF) under one or more contributor
50-
license agreements. See the NOTICE file distributed with this work for
51-
additional information regarding copyright ownership. The ASF licenses this file
52-
to you under the Apache License, Version 2.0 (the "License"); you may not use
53-
this file except in compliance with the License. You may obtain a copy of the
54-
License at
55-
56-
http://www.apache.org/licenses/LICENSE-2.0
57-
58-
Unless required by applicable law or agreed to in writing, software distributed
59-
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
60-
CONDITIONS OF ANY KIND, either express or implied. See the License for the
61-
specific language governing permissions and limitations under the License.

camera/README.md

Lines changed: 0 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -18,56 +18,6 @@ Two API samples:
1818

1919
- [Camera2 Java documentation](https://developer.android.com/reference/android/hardware/camera2/package-summary)
2020

21-
## Pre-requisites
22-
23-
- Android Studio 2.3.0+ with [NDK-r15+](https://developer.android.com/ndk/)
24-
bundle
25-
- Android device running android-24+
26-
27-
## Getting Started
28-
29-
1. Download Android Studio from
30-
[latest stable release](http://developer.android.com/sdk/index.html) or
31-
[canary](http://tools.android.com/download/studio/canary)
32-
1. Launch Android Studio
33-
1. Select "Import project (Eclipse ADT, Gradle,etc)"
34-
1. Browse into downloaded sample directory, select webp/build.gradle
35-
1. Click *Tools/Android/Sync Project with Gradle Files*.
36-
1. Click *Run/Run 'app'*.
37-
3821
## Screenshots
3922

4023
![screenshot](ndkCamera.png)
41-
42-
## Support
43-
44-
If you've found an error in these samples, please
45-
[file an issue](https://github.com/googlesamples/android-ndk/issues/new).
46-
47-
Patches are encouraged, and may be submitted by
48-
[forking this project](https://github.com/googlesamples/android-ndk/fork) and
49-
submitting a pull request through GitHub. Please see
50-
[CONTRIBUTING.md](../CONTRIBUTING.md) for more details.
51-
52-
For generic questions about Android Camera and other feedbacks, please go to
53-
54-
- [Stack Overflow](http://stackoverflow.com/questions/tagged/android-camera)
55-
- [Android Tools Feedbacks](http://tools.android.com/feedback)
56-
57-
## License
58-
59-
Copyright 2015 Google, Inc.
60-
61-
Licensed to the Apache Software Foundation (ASF) under one or more contributor
62-
license agreements. See the NOTICE file distributed with this work for
63-
additional information regarding copyright ownership. The ASF licenses this file
64-
to you under the Apache License, Version 2.0 (the "License"); you may not use
65-
this file except in compliance with the License. You may obtain a copy of the
66-
License at
67-
68-
http://www.apache.org/licenses/LICENSE-2.0
69-
70-
Unless required by applicable law or agreed to in writing, software distributed
71-
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
72-
CONDITIONS OF ANY KIND, either express or implied. See the License for the
73-
specific language governing permissions and limitations under the License.

endless-tunnel/README.md

Lines changed: 0 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,6 @@ to keep the focus on the Android Studio C++ integration. For example, this game
1313
contains textures and geometry hard-coded in code, which works for small demo
1414
games like this one, but doesn't scale well to real games.
1515

16-
This sample uses the new
17-
[Android Studio CMake plugin](http://tools.android.com/tech-docs/external-c-builds)
18-
with C++ support.
19-
20-
## Pre-requisites
21-
22-
- Android Studio 2.2+ with [NDK](https://developer.android.com/ndk/).
23-
24-
## Getting Started
25-
26-
1. [Download Android Studio](http://developer.android.com/sdk/index.html)
27-
1. Launch Android Studio.
28-
1. Open the sample directory.
29-
1. Open *File/Project Structure...*
30-
31-
- Click *Download* or *Select NDK location*.
32-
33-
1. Click *Tools/Android/Sync Project with Gradle Files*.
34-
1. Click *Run/Run 'app'*.
35-
3616
## Screenshots
3717

3818
![screenshot](screenshot.png)
@@ -51,11 +31,6 @@ For more information about this library and its license, please see
5131
[readme.md](https://github.com/g-truc/glm/blob/master/readme.md) and
5232
[copying](https://github.com/g-truc/glm/blob/master/copying.txt).
5333

54-
## Acknowledgements
55-
56-
Most of this code was written by
57-
[Bruno Oliveira](https://plus.google.com/+BrunoOliveira).
58-
5934
## Walkthrough
6035

6136
Source code is under app, it only contains C++ code, which is sitting at its
@@ -178,34 +153,3 @@ The whole game logic is contained in play_scene.cpp. We won't dive into a full
178153
discussion of it, but start reading from the PlayScene::DoFrame() method and it
179154
should become clear. It's a standard game loop that handles input, updates the
180155
world, checks for collisions and renders.
181-
182-
## Support
183-
184-
If you've found an error in these samples, please
185-
[file an issue](https://github.com/googlesamples/android-ndk/issues/new).
186-
187-
Patches are encouraged, and may be submitted by
188-
[forking this project](https://github.com/googlesamples/android-ndk/fork) and
189-
submitting a pull request through GitHub. Please see
190-
[CONTRIBUTING.md](../CONTRIBUTING.md) for more details.
191-
192-
- [Stack Overflow](http://stackoverflow.com/questions/tagged/android-ndk)
193-
- [Android Tools Feedbacks](http://tools.android.com/feedback)
194-
195-
## License
196-
197-
Copyright 2015 Google, Inc.
198-
199-
Licensed to the Apache Software Foundation (ASF) under one or more contributor
200-
license agreements. See the NOTICE file distributed with this work for
201-
additional information regarding copyright ownership. The ASF licenses this file
202-
to you under the Apache License, Version 2.0 (the "License"); you may not use
203-
this file except in compliance with the License. You may obtain a copy of the
204-
License at
205-
206-
http://www.apache.org/licenses/LICENSE-2.0
207-
208-
Unless required by applicable law or agreed to in writing, software distributed
209-
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
210-
CONDITIONS OF ANY KIND, either express or implied. See the License for the
211-
specific language governing permissions and limitations under the License.

exceptions/README.md

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -46,34 +46,3 @@ adapted.
4646
## Screenshot
4747

4848
![screenshot](screenshot.png)
49-
50-
## Support
51-
52-
If you've found an error in these samples, please
53-
[file an issue](https://github.com/googlesamples/android-ndk/issues/new).
54-
55-
Patches are encouraged, and may be submitted by
56-
[forking this project](https://github.com/googlesamples/android-ndk/fork) and
57-
submitting a pull request through GitHub. Please see
58-
[CONTRIBUTING.md](../CONTRIBUTING.md) for more details.
59-
60-
- [Stack Overflow](http://stackoverflow.com/questions/tagged/android-ndk)
61-
- [Android Tools Feedbacks](http://tools.android.com/feedback)
62-
63-
## License
64-
65-
Copyright 2022 Google, Inc.
66-
67-
Licensed to the Apache Software Foundation (ASF) under one or more contributor
68-
license agreements. See the NOTICE file distributed with this work for
69-
additional information regarding copyright ownership. The ASF licenses this file
70-
to you under the Apache License, Version 2.0 (the "License"); you may not use
71-
this file except in compliance with the License. You may obtain a copy of the
72-
License at
73-
74-
http://www.apache.org/licenses/LICENSE-2.0
75-
76-
Unless required by applicable law or agreed to in writing, software distributed
77-
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
78-
CONDITIONS OF ANY KIND, either express or implied. See the License for the
79-
specific language governing permissions and limitations under the License.

gles3jni/README.md

Lines changed: 0 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -13,57 +13,6 @@ ES 2.0 path:
1313
- Explicit assignment of attribute locations, eliminating the need to query
1414
assignments.
1515

16-
This sample uses the new
17-
[Android Studio CMake plugin](http://tools.android.com/tech-docs/external-c-builds)
18-
with C++ support.
19-
20-
## Pre-requisites
21-
22-
- Android Studio 1.3+ with [NDK](https://developer.android.com/ndk/) bundle.
23-
24-
## Getting Started
25-
26-
1. [Download Android Studio](http://developer.android.com/sdk/index.html)
27-
1. Launch Android Studio.
28-
1. Open the sample directory.
29-
1. Open *File/Project Structure...*
30-
31-
- Click *Download* or *Select NDK location*.
32-
33-
1. Click *Tools/Android/Sync Project with Gradle Files*.
34-
1. Click *Run/Run 'app'*.
35-
3616
## Screenshots
3717

3818
![screenshot](screenshot.png)
39-
40-
## Support
41-
42-
If you've found an error in these samples, please
43-
[file an issue](https://github.com/googlesamples/android-ndk/issues/new).
44-
45-
Patches are encouraged, and may be submitted by
46-
[forking this project](https://github.com/googlesamples/android-ndk/fork) and
47-
submitting a pull request through GitHub. Please see
48-
[CONTRIBUTING.md](../CONTRIBUTING.md) for more details.
49-
50-
- [Stack Overflow](http://stackoverflow.com/questions/tagged/android-ndk)
51-
- [Android Tools Feedbacks](http://tools.android.com/feedback)
52-
53-
## License
54-
55-
Copyright 2015 Google, Inc.
56-
57-
Licensed to the Apache Software Foundation (ASF) under one or more contributor
58-
license agreements. See the NOTICE file distributed with this work for
59-
additional information regarding copyright ownership. The ASF licenses this file
60-
to you under the Apache License, Version 2.0 (the "License"); you may not use
61-
this file except in compliance with the License. You may obtain a copy of the
62-
License at
63-
64-
http://www.apache.org/licenses/LICENSE-2.0
65-
66-
Unless required by applicable law or agreed to in writing, software distributed
67-
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
68-
CONDITIONS OF ANY KIND, either express or implied. See the License for the
69-
specific language governing permissions and limitations under the License.

0 commit comments

Comments
 (0)