README gives no indication of what this library does

floooh / sokol

minimal cross-platform standalone C headers

https://floooh.github.io/sokol-html5

zlib License

6.53k stars 467 forks source link

README gives no indication of what this library does #1032

Closed gmofishsauce closed 2 months ago

gmofishsauce commented 2 months ago

The top-level README does not contain a single word about the purpose of this library. This is both elegant and hilarious. Should the README be modified to say something like "...graphics library"? Or something? ;-)

floooh commented 2 months ago

Right at the top:

Simple STB-style cross-platform libraries for C and C++, written in C.

...and just a bit further down:

sokol_gfx.h: 3D-API wrapper (GL/GLES3/WebGL2 + Metal + D3D11 + WebGPU)
sokol_app.h: app framework wrapper (entry + window + 3D-context + input)
...

(the sokol repository is a collection of slightly related libraries, not a single-purpose library)