Update readme with information about C++ for OpenCL. (#587)
Co-authored-by: Sven van Haastregt <sven.vanhaastregt@arm.com>
diff --git a/README.adoc b/README.adoc
index 5cfa8bf..3e50272 100644
--- a/README.adoc
+++ b/README.adoc
@@ -15,7 +15,8 @@
This repository contains the source and tool chain used to generate the
formal OpenCL API, OpenCL Extensions, OpenCL SPIR-V Environment, and
-OpenCL C++ Specifications, as well as the OpenCL 2.2 Reference Pages.
+OpenCL C++ Specifications, as well as the OpenCL 2.2 Reference Pages
+and documentation for the C++ for OpenCL kernel language.
This file describes the repository structure, tools, and build instructions
needed.
@@ -43,21 +44,23 @@
== Repository Structure
|====
-| *File* | *Description*
-| `README.adoc` | This file
-| `Makefile` | GNU Makefile used to build HTML and PDF spec targets
-| `config/` | Support files for asciidoctor build, HTML CSS / Javascript, etc.
-| `katex/` | KaTeX math renderer for HTML outputs
-| `OpenCL_API.txt` | Main source file for the OpenCL API Specification
-| `api/` | Individual sections of the API Specification
-| `OpenCL_Cxx.txt` | Main source file for the OpenCL C++ Specification
-| `cxx/` | Individual sections of the C++ Specification
-| `OpenCL_Env.txt` | Main source file for the OpenCL SPIR-V Environment Specification
-| `env/` | Individual sections of the Environment Specification
-| `OpenCL_Ext.txt` | Main source file for the OpenCL Extensions Specification
-| `ext/` | Individual sections of the Extensions Specification
-| `images/` | Shared images, used by all specs
-| `man/` | Static reference page sources
+| *File* | *Description*
+| `README.adoc` | This file
+| `Makefile` | GNU Makefile used to build HTML and PDF spec targets
+| `config/` | Support files for asciidoctor build, HTML CSS / Javascript, etc.
+| `katex/` | KaTeX math renderer for HTML outputs
+| `OpenCL_API.txt` | Main source file for the OpenCL API Specification
+| `api/` | Individual sections of the API Specification
+| `OpenCL_Cxx.txt` | Main source file for the OpenCL C++ Specification
+| `cxx/` | Individual sections of the C++ Specification
+| `OpenCL_Env.txt` | Main source file for the OpenCL SPIR-V Environment Specification
+| `env/` | Individual sections of the Environment Specification
+| `OpenCL_Ext.txt` | Main source file for the OpenCL Extensions Specification
+| `ext/` | Individual sections of the Extensions Specification
+| `CXX_for_OpenCL.txt` | Main source file for the C++ for OpenCL Documentation
+| `cxx4opencl/` | Individual sections of the C++ for OpenCL Documentation
+| `images/` | Shared images, used by all specs
+| `man/` | Static reference page sources
|====
@@ -73,27 +76,31 @@
for each Specification:
|====
-| *Target* | *Builds*
-| html | HTML outputs for all specifications
-| pdf | PDF outputs for all specifications
-| |
-| api | HTML and PDF outputs for API Specification
-| apihtml | HTML outputs for API Specification
-| apipdf | PDF outputs for API Specification
-| |
-| cxx | HTML and PDF outputs for C++ Specification
-| cxxhtml | HTML outputs for C++ Specification
-| cxxpdf | PDF outputs for C++ Specification
-| |
-| env | HTML and PDF outputs for SPIR-V Environment Specification
-| envhtml | HTML outputs for Environment Specification
-| envpdf | PDF outputs for Environment Specification
-| |
-| ext | HTML and PDF outputs for Extensions Specification
-| exthtml | HTML outputs for Extensions Specification
-| extpdf | PDF outputs for Extensions Specification
-| |
-| manhtmlpages | HTML outputs for Reference Pages
+| *Target* | *Builds*
+| html | HTML outputs for all specifications
+| pdf | PDF outputs for all specifications
+| |
+| api | HTML and PDF outputs for API Specification
+| apihtml | HTML outputs for API Specification
+| apipdf | PDF outputs for API Specification
+| |
+| cxx | HTML and PDF outputs for C++ Specification
+| cxxhtml | HTML outputs for C++ Specification
+| cxxpdf | PDF outputs for C++ Specification
+| |
+| env | HTML and PDF outputs for SPIR-V Environment Specification
+| envhtml | HTML outputs for Environment Specification
+| envpdf | PDF outputs for Environment Specification
+| |
+| ext | HTML and PDF outputs for Extensions Specification
+| exthtml | HTML outputs for Extensions Specification
+| extpdf | PDF outputs for Extensions Specification
+| |
+| cxx4opencl | HTML and PDF outputs for C++ for OpenCL Documentation
+| cxx4openclhtml | HTML outputs for C++ for OpenCL Documentation
+| cxx4openclpdf | PDF outputs for C++ for OpenCL Documentation
+| |
+| manhtmlpages | HTML outputs for Reference Pages
|====
The specification targets are generated in `out/html/` for HTML targets,