From 75c6db0746022c00322fe6d8a525ff00642fba78 Mon Sep 17 00:00:00 2001 From: David Neto Date: Tue, 9 Aug 2016 17:57:18 -0400 Subject: [PATCH] Fix paths in the README. --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 4955b0d..d074591 100644 --- a/README.md +++ b/README.md @@ -144,13 +144,13 @@ The library provides a C API, but the internals use C++11. In order to use the library from an application, the include path should point to `/include`, which will enable the application to include the -header `/include/libspirv/libspirv.h` then linking against the -static library in `/libSPIRV-Tools.a` or -`/SPIRV-Tools.lib`. +header `/include/spirv-tools/libspirv.h` then linking against the +static library in `/source/libSPIRV-Tools.a` or +`/source/SPIRV-Tools.lib`. * `SPIRV-Tools` CMake target: Creates the static library: - * `/libSPIRV-Tools.a` on Linux and OS X. - * `/libSPIRV-Tools.lib` on Windows. + * `/source/libSPIRV-Tools.a` on Linux and OS X. + * `/source/libSPIRV-Tools.lib` on Windows. #### Entry points @@ -177,11 +177,11 @@ assembly and binary files with suffix `.spvasm` and `.spv`, respectively. The assembler reads the assembly language text, and emits the binary form. The standalone assembler is the exectuable called `spirv-as`, and is located in -`/spirv-as`. The functionality of the assembler is implemented +`/tools/spirv-as`. The functionality of the assembler is implemented by the `spvTextToBinary` library function. * `spirv-as` - the standalone assembler - * `/spirv-as` + * `/tools/as` Use option `-h` to print help. @@ -190,11 +190,11 @@ Use option `-h` to print help. The disassembler reads the binary form, and emits assembly language text. The standalone disassembler is the executable called `spirv-dis`, and is located in -`/spirv-dis`. The functionality of the disassembler is implemented +`/tools/spirv-dis`. The functionality of the disassembler is implemented by the `spvBinaryToText` library function. * `spirv-dis` - the standalone disassembler - * `/spirv-dis` + * `/tools/dis` Use option `-h` to print help. @@ -209,26 +209,26 @@ in the specified order. This is a work in progress, with initially only few available transformations. * `spirv-opt` - the standalone optimizer - * `/spirv-opt` + * `/tools/opt` ### Validator tool *Warning:* This functionality is under development, and is incomplete. The standalone validator is the executable called `spirv-val`, and is located in -`/spirv-val`. The functionality of the validator is implemented +`/tools/spirv-val`. The functionality of the validator is implemented by the `spvValidate` library function. The validator operates on the binary form. * `spirv-val` - the standalone validator - * `/spirv-val` + * `/tools/val` ### Tests Tests are only built when googletest is found. -The `/UnitSPIRV` executable runs the project tests. +The `/test/UnitSPIRV` executable runs the project tests. It supports the standard `googletest` command line options. The project also adds a CMake test `spirv-tools-testsuite`, which executes -- 2.7.4