Skip to content

Commit bb08583

Browse files
committed
Document Docker build
The repository README doesn't currently mention Docker, but this is the easiest way to build the OpenCL-Docs specs, as opposed to manually configuring some quite dated ruby dependencies. This PR updates the README to alert to developers that Docker is available help them build the project. It is worth noting that the build instructions for both [Vulkan BUILD.adoc](https://github.com/KhronosGroup/Vulkan-Docs/blob/main/BUILD.adoc#khronos-provided-docker-image) and [SYCL README](https://github.com/KhronosGroup/SYCL-Docs#building-using-the-khronos-docker-image) only document building the project using the docker image. We should consider whether we want a larger rewrite of the OpenCL REAME to only describe building the repo in terms of Docker, but for now the PR makes an incremental improvement.
1 parent 1f2a44a commit bb08583

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

README.adoc

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,16 @@ We intend to maintain a linear history on the GitHub `main` branch.
7373
[[building]]
7474
== Building The Specifications and Reference Pages
7575

76-
If you have installed all <<depends,required toolchain components>>, you
77-
should be able to build both HTML and PDF outputs for all specifications by:
76+
After cloning the repository you should install all of the <<depends,required toolchain components>>.
77+
The recommended way to do this is by using the Khronos provided Docker image
78+
`khronosgroup/docker-images:asciidoctor-spec` from DockerHub.
79+
The Dockerfile specifying this image can be found at
80+
https://github.com/KhronosGroup/DockerContainers[KhronosGroup/DockerContainers]
81+
if you need to build a modified or layered image. Due to local and CI caching problems when this image
82+
is updated on dockerhub, the CI uses the SHA256 of the latest image update, rather than the image name.
83+
84+
Once you have installed all the dependencies you should be able to build both HTML
85+
and PDF outputs for all specifications by:
7886

7987
$ make
8088

0 commit comments

Comments
 (0)