The ideal README file looks good in a terminal, but also has a bit of markup to make it look prettier on a code forge (e.g. Sourcehut, Codeberg). I believe markdown provides too much formatting (markdown links are particuarly ugly), and I just realized that README files are a perfect application for gemtext: https://gemini.circumlunar.space/docs/gemtext.gmi
@eamon Markdowns can get far too complicated for their own good, and Gemtext looks like a nice lightweight approach :-)
But a while ago, I was introduced to the idea of breaking up sentences/paragraphs in a source text document into their 'semantic parts', so that when you made edits it was easier to see in the diffs just what had changed.
But a while ago, I was introduced to
the idea of
breaking up sentences/paragraphs
in a source text document
into their 'semantic parts',
so that when you made edits
it was easier to see in the diffs
just what had changed.
The Gemtext approach would make that difficult, because there are no hints available to the editor that I'm aware of that would preserve this.
Interested in opinions and comments about this :-)
@zachdecook @yojimbo I think there's a balancing act between adopting our tools to our practices vs the converse. I'm not sure how I feel about the practice of breaking up text into "semantic parts"—this is the first time I've ever heard of the idea! I would probably have to try it to have a reliable opinion.
I've also never used diff-so-fancy. I'm learning about so many cool tools and ideas here... thank you both!