Document Docker build#1572
Open
EwanC wants to merge 1 commit into
Open
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The repository README doesn't currently mention Docker, but this is by far the easiest way to build the OpenCL-Docs specs, as opposed to manually configuring some quite dated ruby dependencies. It is also how CI is testing the project, so the most faithful to reproduce any CI errors.
This PR updates the README to alert to developers that a Docker image is available help them build the project.
It is worth noting that the build instructions in both Vulkan-Docs BUILD.adoc and SYCL-Docs README only document building the project using a docker image. We should consider whether we want a larger rewrite of the OpenCL-Docs REAME to only describe building the repo in terms of Docker, but for now the PR makes an incremental improvement.