3 ms·
What I usually do is: Title AI Generated image serving as a Logo/social preview/etc Badges(I really want 88x31 to be a thing again!) Quote(I usually try to f
by eternityforest 2y ago
What I usually do is:
Title
AI Generated image serving as a Logo/social preview/etc
Badges(I really want 88x31 to be a thing again!)
Quote(I usually try to find a quote for every heading, the way books used to for chapters)
Elevator pitch, 1 or two paragraphs should be enough to know if the project is relevant to you.
Heading (Add an emoji to your headings to make it feel like a proper git project)
Install instructions. If this takes more than a paragraph I assume your project is tinkerers-only stuff that's going to need maintenance, so I like to show off how few steps are needed.
The quotes are mostly flavor/Easter eggs, but they do have a function breaking up the wall of text feeling, as a more fun alternative to whitespace that also acts as a visual marker with a recognizable texture.