← Back to context

Comment by minraws

1 day ago

I don't get this comment, the readme felt like slop to me. What makes this any better.. I genuinely want to understand why someone thinks this is a good readme sure I may have seen worse but I have seen much better readmes.

The very first line of their README: "Blender's user interface, as a library you can use from Python, Rust, JavaScript (React, Svelte), C, C++ and Dear ImGui."

Then, the README very quickly continues with "What BUI is" and "Why BUI exists". These are all the exact things I want to know, ASAP, when I encounter a new project. The language reads perfectly fine to me.

Here is another example of a nice README: https://github.com/mpv-player/mpv

Do you know what I don't want to know first? What the startup time is, what language you wrote it in (because you think it makes your project cooler), some other random internal details about the performance of the thing, when I don't even yet know what the thing is.

  • > what language you wrote it in

    You mean something like:

    > turns it into a standalone UI library with a small C core

    ...?

    Or this:

    > At the heart of BUI is the kit: a small runtime written in C

    ......??

    I personally have no issue of this, but the more I read your comments the more confused I got.