summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Yiwei Zhang <zzyiwei@google.com> 2019-08-06 19:26:18 -0700
committer Yiwei Zhang <zzyiwei@google.com> 2019-08-06 19:28:36 -0700
commit113ee6a8d0ee06303b664e71d09f5709932b94bc (patch)
treee90f33f8fb542c63cca85b46a33b36bfed61a6e9
parentdcaba1b880199996f14e211877f78ff7d7964a42 (diff)
vulkan: combine doc with README.md file
Bug: 134185757 Test: build Change-Id: Ib0cba55e07df92183c4a0ab1851d5610c9de4ac9
-rw-r--r--vulkan/README.md11
-rw-r--r--vulkan/doc/README2
2 files changed, 8 insertions, 5 deletions
diff --git a/vulkan/README.md b/vulkan/README.md
index 0f660977f9..185aa39da6 100644
--- a/vulkan/README.md
+++ b/vulkan/README.md
@@ -2,6 +2,10 @@
This subdirectory contains Android's Vulkan loader, as well as some Vulkan-related tools useful to platform developers.
+## Documentation
+
+The former contents of doc/implementors_guide/ are now at https://source.android.com/devices/graphics/implement-vulkan.
+
## Coding Style
We follow the [Chromium coding style](https://www.chromium.org/developers/coding-style) for naming and formatting, except with four-space indentation instead of two spaces. In general, any C++ features supported by the prebuilt platform toolchain are allowed.
@@ -12,6 +16,7 @@ Use "clang-format -style=file" to format all C/C++ code, except code imported ve
We generate several parts of the loader and tools driectly from the Vulkan Registry (external/vulkan-headers/registry/vk.xml). Code generation must be done manually because the generator is not part of the platform toolchain (yet?). Files named `foo_gen.*` are generated by the code generator.
- To run the generator:
-- Install Python3 (if not already installed)
-- `$ ./<path to>/frameworks/native/vulkan/scripts/code_generator.py`
+### Run The Code Generator
+
+Install Python3 (if not already installed) and execute below:
+`$ ./scripts/code_generator.py`
diff --git a/vulkan/doc/README b/vulkan/doc/README
deleted file mode 100644
index d1dc2e1b7c..0000000000
--- a/vulkan/doc/README
+++ /dev/null
@@ -1,2 +0,0 @@
-The former contents of implementors_guide/ are now at
-https://source.android.com/devices/graphics/implement-vulkan