logoalt Hacker News

rmunn • today at 2:06 PM • 1 reply • view on HN

Info-dense, completely unreadable README.md file. Only the line "No Puppeteer, no Chromium IPC, no `page.screenshot()`" actually allowed me to figure out what this is about: creating video demos of your website (and probably other software as well) with an AI agent, rather than going through the conventional video-editing process.

It's cool that so many people are building useful tools with LLMs, but for the love of ones and zeroes, people! PLEASE write your README by hand, instead of handing it off to the LLM with no human involvement! You know how unreadable LLM prose is! Why do you make that the first thing people see when they see your repo?


Replies

rmunn • today at 2:34 PM

I mean, I'd even be happy(-ish) with a README that starts out "Apologies for the LLM text below, but this is still in heavy development, and I haven't gotten around to writing a proper README yet. In the meantime, though, here's something the LLM slapped together which is at least better than nothing."

Stick that in front of your wall of LLM text, and I'd at least have confidence that some day you're going to come back and make the README readable.

➕ show 1 reply