Docs don't show all features

hadronized / glsl

GLSL parser for Rust

190 stars 28 forks source link

Docs don't show all features #111

Open dhardy opened 4 years ago

dhardy commented 4 years ago

The SPIR-V transpiler doesn't show up in the docs.

You probably want this in your Cargo.toml:

[package.metadata.docs.rs]
all-features = true

It would also be nice to see a transpiling example included in the docs.

hadronized commented 4 years ago

Hello,

Yes, currently, it doesn’t show up because I don’t really know whether the glsl crate is a good place to put such a transpiler in. glsl -> glsl is trivial so it’s okay to have it there, but for anything else, I’m quite not sure. What do you think?

dhardy commented 4 years ago

I don't know. I was just looking for a GLSL → SPIR-V compiler since the glsl-to-spirv is deprecated and was wondering if there was a pure-Rust solution — but I see you use shaderc anyway.

hadronized commented 4 years ago

So far, yes. But the goal is to use pure Rust. I haven’t spent the time to write a semantic analysis phase but IIRC @jrmuizel has information about that.