Skip to content

Commit ccceba9

Browse files
author
sjfricke
committed
Cleaned up READMEs
Made the READMEs more GitHub Markdown friendly and fixed a few small errors, just trying to make a little nicer to view online
1 parent d6508a3 commit ccceba9

File tree

7 files changed

+33
-33
lines changed

7 files changed

+33
-33
lines changed

‎README.md

+15-23
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
Tutorial Samples
22
================
33
A set of samples to illustrate Vulkan API on Android with Android Studio
4-
To build on windows for tutorial02/03, copy/install ndk-r12 ( or better ) to a directory close to root dir ( c: ) to workaround command path 260 character limit issue;see totorial02/03's build.gradle for details. To Build samples:
4+
To build on windows for tutorial02/03, copy/install ndk-r12 ( or better ) to a directory close to root dir ( C: ) to workaround command path 260 character limit issue; see tutorial02/03's build.gradle for details. To Build samples:
55
- Inside Andriod, menu File --> New --> Import Project
66
- Find your sample's build.gradle and open it
77
This will force andrioid studio to create local.properties file to config your SDK and NDK location; if you see error during importing, open local.properties file and correct the NDK and SDK location, then re-sync.
88

9-
109
Other Resources:
1110
Additional Android Studio/NDK samples:
1211
- [Android Vulkan API Basic Samples](https://github.com/googlesamples/vulkan-basic-samples)
@@ -15,21 +14,20 @@ Additional Android Studio/NDK samples:
1514

1615
Contents
1716
-------------
18-
1. tutorial01_load_vulkan
19-
- create a vulkan device
20-
2. tutorial02_prebuilt_layers
21-
- create a vulkan device with vulkan validation layers
22-
3. tutorial03_traceable_layers
23-
- create a vulkan device with validation layers that could be traced.
17+
- [Tutorial 1 - Load Vulkan](./tutorial01_load_vulkan)
18+
- create a vulkan device
19+
- [Tutorial 2 - Prebuilt Layers](./tutorial02_prebuild_layers)
20+
- create a vulkan device with vulkan validation layers
21+
- [Tutorial 3 - Traceable Layers](./tutorial03_traceable_layers)
22+
- create a vulkan device with validation layers that could be traced.
2423
Refer to README.md under its directory
25-
4. tutorial04_first_window
26-
- create a vulkan window with WSI
27-
5. tutorial05_triangle
28-
- draw a simple triangle with Android Studio integrated shaderc feature
29-
6. tutorial06_texture
30-
- draw textured triangle with [CDep](https://github.com/google/cdep) packed shaderc pre-built binary
31-
- glsl shaders are compiled at app run time (similar to openGL traditional shader compiling model)
32-
24+
- [Tutorial 4 - First Window](./tutorial04_first_window)
25+
- create a vulkan window with WSI
26+
- [Tutoiral 5 - Triangle](./tutorial05_triangle)
27+
- draw a simple triangle with Android Studio integrated shaderc feature
28+
- [Tutorial 6 - Texture](./tutorial06_texture)
29+
- draw textured triangle with [CDep](https://github.com/google/cdep) packed shaderc pre-built binary
30+
- glsl shaders are compiled at app run time (similar to openGL traditional shader compiling model)
3331

3432
Pre-requisites
3533
--------------
@@ -63,7 +61,6 @@ then "mathfu" --> "Tasks" --> "other" --> "get_mathfu".
6361
1. Click *Tools/Android/Sync Project with Gradle Files*.
6462
1. Click *Run/Run 'app'*.
6563

66-
6764
License
6865
-------
6966
Copyright 2016 Google, Inc.
@@ -81,9 +78,4 @@ Unless required by applicable law or agreed to in writing, software
8178
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
8279
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
8380
License for the specific language governing permissions and limitations under
84-
the License.
85-
86-
87-
88-
89-
81+
the License.

‎tutorial02_prebuild_layers/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Tutorial 02 - use validation layers - 1
66

77
Verification
88
============
9-
Planted error: this sample sets VkDeviceQueueCreateInfo::pQueuePriorities to nullptr,
9+
Planted error: this sample sets `VkDeviceQueueCreateInfo::pQueuePriorities` to nullptr,
1010
which will trigger validation layers to notify us from registered callback function
11-
vkDebugReportCallbackEX_impl(); putting a breakpoint with Android Studo, observe
11+
`vkDebugReportCallbackEX_impl();` putting a breakpoint with Android Studo, observe
1212
the breakpoint being triggered.
1313

1414

‎tutorial03_traceable_layers/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Tutorial 03 - traceable_layers
22
===============================
3-
This has the same functionality as tutorial02, but building the validation layers
3+
This has the same functionality as [Tutorial 2](../tutorial02_prebuild_layers), but building the validation layers
44
from the source code inside $NDK_DIR/sources/third_party/vulkan so application could
55
trace code into layers from application. This would help in certain case developers
66
want to see what validation layer is checking for application failed cases, in return
@@ -41,16 +41,16 @@ Build Instructions
4141
-------------------
4242
- import the sample into your android studio (2.2.0 beta and above)
4343
- check local.properties pointing to the right NDK on HOST build machine
44-
- select ndk-build or cmake in layerlib/build.gradle '''def USE_CMAKE = 0'''. if you are switching
44+
- select ndk-build or cmake in layerlib/build.gradle `def USE_CMAKE = 0`. if you are switching
4545
back and forth between cmake and ndk-build, before every build after switching, remove intermediate
46-
cached build scripts with ''' rm -fr layerlib/.external* layerlib/build app/.external* app/build'''
46+
cached build scripts with `rm -fr layerlib/.external* layerlib/build app/.external* app/build`
4747

4848
known issues:
4949
- windows could not build layers with ndk-build usage model, working on it
5050

5151
**Windows build extra steps**
5252
if you see errors while building validation layers, try the following workaround:
53-
- copy your ndk to be directly under c:\
53+
- copy your ndk to be directly under C:\
5454
- configure your ndk.dir inside local.properties to your new ndk location
5555
this is due to the fact that commend path is above 260 when source is inside ndk
5656

‎tutorial05_triangle/README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,7 @@
1-
#Tutorial 1 - Opening a window
1+
# Tutorial 5 - Creating a triangle
22

3+
Create a triangle and draw it to the screen
4+
5+
Screenshot
6+
----------
7+
<img src="./Tutorial_5_Screenshot.png" height="400px">

‎tutorial05_triangle/Tutorial_5_Screenshot.png

14.2 KB
Loading

‎tutorial06_texture/README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Description
88
* adding texture to triangle
99
* using shaderc [CDep](https:/github.com/google/cdep) package, which is temporarily hosted on [github repo](https://github.com/ggfan/shaderc/releases)
1010
This sample builds the glsl shaders into spir-V at appliation run-time,
11-
with [shaderc]https://github.com/google/shaderc)
11+
with [shaderc](https://github.com/google/shaderc)
1212
pre-build binaries saved as [CDep](https:/github.com/google/cdep)
1313
package at a [fork](https://github.com/ggfan/shaderc/releases)
1414

@@ -18,8 +18,11 @@ feedbacks are very welcome here or [CDep page](https://github.com/google/cdep)!
1818
Prerequirement
1919
--------------
2020
Before building this sample, do:
21-
* cd ${your_tutorial06_textyre}
22-
* ./cdep ( or cdep.bat)
21+
* `cd ${your_tutorial06_texture}`
22+
* `./cdep` ( or `cdep.bat`)
2323

2424
Then import the sample into Android Studio
2525

26+
Screenshot
27+
------------
28+
<img src="./Tutorial_6_Screenshot.png" height="400px">

‎tutorial06_texture/Tutorial_6_Screenshot.png

17.9 KB
Loading

0 commit comments

Comments
 (0)