aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Neto <dneto@google.com>2020-08-24 11:45:58 -0700
committerGitHub <noreply@github.com>2020-08-24 14:45:58 -0400
commit55c74ff5811f8ca0c7087739b9c5a597b38ffa9b (patch)
tree6e7ec56c03cdd1522ac9698ad1df9e6315fe08fe
parentf02ecc0f5f7844c8c8557a3b773e1fab12a64747 (diff)
downloadamber-55c74ff5811f8ca0c7087739b9c5a597b38ffa9b.tar.gz
Update README: Point to examples (#907)
Points to this repo and to Vulkan CTS.
-rw-r--r--README.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.md b/README.md
index 8b1127b..a9755ec 100644
--- a/README.md
+++ b/README.md
@@ -277,8 +277,7 @@ export VK_ICD_FILENAMES=$PWD/Linux/vk_swiftshader_icd.json
The build will generate an `out/Debug/amber` executable which can be used to
run amber scripts. The script can be used as
-`out/Debug/amber <path to amber file>`. Where, currently, the amber file is
-in the [VkScript](docs/vk_script.md) format.
+`out/Debug/amber <path to amber file>`.
```
out/Debug/amber tests/cases/clear.amber
@@ -287,6 +286,16 @@ out/Debug/amber tests/cases/clear.amber
The sample app returns a value of 0 on success or non-zero on error. Any issues
encountered should be displayed on the console.
+Run `out/Debug/amber -h` to see a description of the program's command line options.
+
+Example AmberScript files can be found in the [tests/cases](tests/cases)
+directory in this repository.
+Also the [Vulkan Conformance Test
+Suite](https://github.com/KhronosGroup/VK-GL-CTS) contains many real-world
+examples in its
+[external/vulkancts/data/vulkan/amber](https://github.com/KhronosGroup/VK-GL-CTS/tree/master/external/vulkancts/data/vulkan/amber)
+subdirectory.
+
By default, `out/Debug/amber` supports saving the output image into '.png'
file. You can disable this by passing `-DAMBER_SKIP_LODEPNG=true` to cmake.