Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #28

Open
kobutri opened this issue Jul 19, 2017 · 1 comment
Open

Documentation #28

kobutri opened this issue Jul 19, 2017 · 1 comment

Comments

@kobutri
Copy link

kobutri commented Jul 19, 2017

I would really like to see a comprehensive documentation or at least a proper guide.
Vulkan is pretty complex for beginners and this Wrapper seems to provide the much needed simplification needed to write efficient code, especially for starters. But without a real documentation it is not really of use for this group. I have to admit that I am not really sure wether those kind of people are targeted.
Non the less it would be really kind to provide some more help, not just examples.

@DominikWitczakAMD
Copy link
Contributor

While I personally sympathize with your view, I'm afraid we don't have free cycles at the moment to write any sort of a more thorough introduction to the library. It's not only that though.

Thing to keep in mind is that Vulkan is a "living organism", new functionality is added quite frequently. One of Anvil's goals is to keep up with the progress. Having a more thorough documentation (separate from doxygen tags that we do place all around our code and comment blocks for chunks that may take people some time to get their head around) would mean we would also need to revisit it every couple of months. That doesn't exactly work with the bandwidth we have at hand.

That being said, we would be more than happy to see the community help us with this task.

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

No branches or pull requests

2 participants