Currently, the repo lacks docs on setting up & using libsimplewebm. This makes it harder for devs on how to setup & integrate the library.
The goal is to make it easier for devs on how to use it. Here is something that we could do:
- Overview: Brief introduction to what
libsimplewebm does (Already done in the README)
- Prerequisites & Dependencies: Tools & libraries required to build & run
libsimplewebm (Partially done in the README)
- Installation / Build Instructions: Step-by-step guide to compiling & linking the library (Already done in the README but could use some work)
- Basic Usage & Code Examples: Simple code snippet(s) demonstrating common use cases (TODO)
- API Reference: High-level overview of core functions and classes (TODO)
Currently, the repo lacks docs on setting up & using
libsimplewebm. This makes it harder for devs on how to setup & integrate the library.The goal is to make it easier for devs on how to use it. Here is something that we could do:
libsimplewebmdoes (Already done in the README)libsimplewebm(Partially done in the README)