TIL you can make "GIFs" with SVGs for GitHub README.md files

https://koaning.io/posts/svg-gifs/

#README: Brief #introduction
I’m an #adminIT focused on #SML & #LMOM labs (#STI / #EPFL) open to advance other projects/groups too.
current load: 50% CPU - two threads free, ready to fork.

Otherwise,
I capture our scientific worlds in images.
#EPFLsciencephotography @epflphotography

#sciencephotography, #sciencephotograher
#macro #liquids #metals #materials #powders

#README : Brève #introduction
Je suis #adminIT dans les labos {#SML, #LMOM} @ #STI / #EPFL – dispo et enthousiaste pour contribuer à d’autres projets en soutien informatique ou photo.
cad.: charge actuelle : 50% CPU – 2x thread libre, prêt à forker.

Autrement,
je capture nos mondes scientifiques en images.
#EPFLsciencephotography @epflphotography

#sciencephotography
#sciencephotographer

GitHub Profile README Generator
“GitHub Profile README Generator is an OSS (Open Source Software) that provides a cool interface to generate GitHub profile README in (JSON) markdown.”

Source: https://rahuldkjain.github.io/gh-profile-readme-generator/

I had a moment of inspiration and created #ggg take a look (still #experimental #foss software)

ggg: #guile #scheme #glyph #generator

https://codeberg.org/jjba23/ggg

Through #svg generation from #lisp we leverage a (wip) #dsl and apply some #math knowledge to build pixel perfect project #markdown / #org badges.

It also scripts #imagemagick to export to #png or #webp .

You can then use the svgs in your #codeberg (or #github) repository #readme for example.

I provide a #guix manifest in the repo

I finally got around to making a more or less generic sketch to demonstrate the #MutableInstruments Braids port to arduino. It's at https://github.com/poetaster/arduinoMI/tree/main/BraidsEngines with minimal instructions in the Repo #README It's a real challenge getting decent audio output but Braids is nice and rings is nice. Plaits is still a bit bitchy, but, somewhat usable :) here is an example of what usable means (abusing FM)

READMEs are deceptively simple files. They are regularly overlooked, but, make no mistake, they are worth their weight in gold!

In this session, Swapnil Ogale will dust off the cobwebs off the lost art of good README documentation and provide some tips on how to create docs that work for multiple audiences.

Get your tickets now! https://www.dddmelbourne.com/tickets

In the spirit of inclusive design, I recently learned that it is better to remove hard line breaks from READMEs.

This advice was news to me, so I've written it down to share:

https://marijkeluttekes.dev/blog/articles/2024/12/05/remove-hard-line-breaks-from-readmes/

Am I the only one who gets annoyed when when a project's README looks like this? No example code. No CLI synopsis. No in-depth description or explaination. No screenshots or videos/gifs. Just a short summary and a link to the website or maybe the API documentation. Please don't force me to dig deeper just to figure out what your project does or how to use it.
https://github.com/inertiajs/inertia#readme

The easiest way to create a README
https://readme.so
#ycombinator #readme #easiest #create #markdown #git #github #gitlab

#libobscura is going through the final crunch... I mean, touches, before release.

I just realized the project page and the #readme are like continuous announcement posts. For some people, it's going to be the first contact with your work, so tell them;

- are they the intended audience?
- how do they benefit from this?
- where is the project going?
- how far along is it?
- how to try it out?

/me goes back to rewriting

[SOLVED] I am pretty sure I've seen somebody updating a README.md file by #Python snippets in the comments of that very #README.
I think they did it for their #GitHub profile page.
But I cannot find that, now when I need it. Please help.

Edit: Solved by https://mastodon.social/@hugovk/113267200418453876

„Männliches Schreiben, das Männlichkeitsvorstellungen vermutlich stärker formte als jede andere kulturelle Praxis, erfährt [...] nur selten historiografiegeschichtliche Aufmerksamkeit.“

In ihrer neuen Publikation „Männer über sich. Wissenschaft - Biografie - Geschlecht“ untersuchen Mirjam Hähnle (#GHILondon), Maximiliane Berger und Anna Leyrer (beide Uni Basel) das männliche Schreiben und die kulturelle Praxis dahinter.

Jetzt im neuen #readme.txt mehr erfahren!
https://gab.hypotheses.org/14368

Hey there world! I'm non binary, ace, and a proud furry! Usually, I go by Trashy for those I don't know, but my name is WAD3 (Wade)! I'm usually pretty shy, but I can talk a lot once I get to know you.

I am a large, musky, digital/Stinkware raccoon named WAD3. Their main purpose is to take care of networks, as well as all connected devices, all over my fictional worlds! On each, cleaning up junk files, organizing clutter, and disposing of malware! Of course, they have a physical form too.

Despite being in the Fandom for some time, I've only more recently been able to really drown out the noise of my past and find myself. It is my intention that as I make progress on further discoveries, and in the Fandom, I can share it here!

I'm very into all things fluff, especially raccoons, as well as waste logistics/disposal, Linux & open source tech, coffee, audio, iPods, and other older technologies. For the past six years of my life, I've also been working on building lore worlds in which my characters and sometimes friends go on all sorts of crazy adventures! I also game, read, and vibe a little here and there.

There may not be much here now, but it is my hope that as I discover more about myself and gain a little more confidence, I'll have a little more to show, and thus hopefully, this will be updated frequently "^^

Thank you all for taking the time to read a little about me. I hope you have a wonderful day! Stay wild, and as Adler the Eagle once said, don't forget to help someone smile today!

We've recently updated the repository description and corrected several typos in the README.md file. Keeping our documentation clear and accurate is essential for our global team and all contributors, ensuring that everyone can seamlessly work with the codebase. Clear communication aids in fostering collaboration and maintaining a high standard within our projects. #opensource #collaboration #softwaredevelopment #readme #globalteam

Best #readme #logo ever!

https://github.com/dbus2/zbus/

Sebastian Willert widmet sich in seinem Buch der Frage danach, wie deutsche Archäologen Altertümer aus dem Osmanischen Reich nach Preußen brachten - und welche diplomatische Krisen damit ausgelöst wurden. #readme.txt-Interview: https://gab.hypotheses.org/13950
1/2

"As its name suggests, it contains a list of breaking changes that we would like to introduce in the future. Every change should include what needs to be changed, and the rationale behind it. When working on future releases, developers can refer to this file to understand the breaking changes that we have been considering."
#oss #readme #github

https://pepicrft.me/blog/2024/06/25/breakme