kassane / kassane/libvlc-zig

Better documentation on usage

Open
#14 1 comment 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Zig
Stars
21
Forks
1
PR merge metrics
No merged PRs in 30d

Description

This library seems to be kind of unconventional on how you are supposed to add it to your project. There doesn't seem to be any module that I can directly use or anything of the like? Are we expected to just copy over the stuff from the build.zig? That seems like a lot of boilerplate.

Contributor guide

Open the contributing guide

Research direction

Start by reading build.zig and the existing project documentation to understand how libvlc-zig is currently added to a Zig project. Clarify the intended integration approach and document the required setup and usage; done means a newcomer can follow the documented steps without copying unexplained boilerplate.

Written by the indexing model from the issue text.

Assessment

Tech stack
zig
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.