Skip to content

Update DXC readme to reference Vulkan#8604

Open
llvm-beanz wants to merge 1 commit into
microsoft:mainfrom
llvm-beanz:readme-vulkan
Open

Update DXC readme to reference Vulkan#8604
llvm-beanz wants to merge 1 commit into
microsoft:mainfrom
llvm-beanz:readme-vulkan

Conversation

@llvm-beanz

Copy link
Copy Markdown
Collaborator

It was pointed out to me that we don't actually mention our Vulkan support clearly and prominently in our README. This hopefully addresses that.

It was pointed out to me that we don't actually mention our Vulkan
support clearly and prominently in our README. This hopefully addresses
that.
Comment thread README.md
## Features and Goals

The starting point of the project is a fork of the [LLVM](http://llvm.org/) and [Clang](http://clang.llvm.org/) projects, modified to accept HLSL and emit a validated container that can be consumed by GPU drivers.
The starting point of the project is a fork of the [LLVM](http://llvm.org/) and [Clang](http://clang.llvm.org/) projects, modified to accept HLSL and emit a validated shader binary that can be consumed by GPU drivers.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not part of this change but I wonder if would be worth it to have a link that provides more information on what validation actually means? I see that we've got some info in dxil.rst. Not sure if we have more thorough documentation anywhere else.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I'd want to go into the details of shader bytecode validation in the README, but I do think we should document it better. We validate both DXIL and SPIRV, so it isn't unique to DXIL.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, thats why I mentioned just adding a link. But I didn't find any documentation that I think would be worthwhile linking.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: New

Development

Successfully merging this pull request may close these issues.

5 participants