#readme — Public Fediverse posts

«Боргворглер: боргает ворглер», или как сделать действительно полезную документацию к проекту

Обсуждения неудачных примеров README-файлов и документации — одна из популярных тем на профильных площадках и форумах [вкупе с другими «вечнозелеными» спорами в ИТ]. Мы в

https://habr.com/ru/companies/beeline_cloud/articles/1036004/

#beeline_cloud #документация #readme #подготовка_документации #документирование_кода

«Боргворглер: боргает ворглер», или как сделать действительно полезную документацию к проекту

Обсуждения неудачных примеров README-файлов и документации — одна из популярных тем на профильных площадках и форумах [вкупе с другими «вечнозелеными» спорами в ИТ]. Мы в

https://habr.com/ru/companies/beeline_cloud/articles/1036004/

#beeline_cloud #документация #readme #подготовка_документации #документирование_кода

«Боргворглер: боргает ворглер», или как сделать действительно полезную документацию к проекту

Обсуждения неудачных примеров README-файлов и документации — одна из популярных тем на профильных площадках и форумах [вкупе с другими «вечнозелеными» спорами в ИТ]. Мы в

https://habr.com/ru/companies/beeline_cloud/articles/1036004/

#beeline_cloud #документация #readme #подготовка_документации #документирование_кода

«Боргворглер: боргает ворглер», или как сделать действительно полезную документацию к проекту

Обсуждения неудачных примеров README-файлов и документации — одна из популярных тем на профильных площадках и форумах [вкупе с другими «вечнозелеными» спорами в ИТ]. Мы в

https://habr.com/ru/companies/beeline_cloud/articles/1036004/

#beeline_cloud #документация #readme #подготовка_документации #документирование_кода

15 Essential Sections Every README Needs: Give Your Project What It Deserves, by (not on Mastodon or Bluesky):

https://dev.to/georgekobaidze/15-essential-sections-every-readme-needs-give-your-project-what-it-deserves-fie

#readme #documentation

15 Essential Sections Every README Needs: Give Your Project What It Deserves, by (not on Mastodon or Bluesky):

https://dev.to/georgekobaidze/15-essential-sections-every-readme-needs-give-your-project-what-it-deserves-fie

#readme #documentation

15 Essential Sections Every README Needs: Give Your Project What It Deserves, by (not on Mastodon or Bluesky):

https://dev.to/georgekobaidze/15-essential-sections-every-readme-needs-give-your-project-what-it-deserves-fie

#readme #documentation

15 Essential Sections Every README Needs: Give Your Project What It Deserves, by (not on Mastodon or Bluesky):

https://dev.to/georgekobaidze/15-essential-sections-every-readme-needs-give-your-project-what-it-deserves-fie

#readme #documentation

15 Essential Sections Every README Needs: Give Your Project What It Deserves, by (not on Mastodon or Bluesky):

https://dev.to/georgekobaidze/15-essential-sections-every-readme-needs-give-your-project-what-it-deserves-fie

#readme #documentation

'One of The Scariest Things I Have Seen': Alarms Sound Over 'Technofascist' Palantir Manifesto | Common Dreams

> Palantir are Enemies of humanity.

#palantir #manifesto #technofascism #alexkarp #karp #readme #politics #AIauthoritarian #Americentric #fckusa #boycottamericantech

https://www.commondreams.org/news/palantir-technofascist-manifesto-criticism

'One of The Scariest Things I Have Seen': Alarms Sound Over 'Technofascist' Palantir Manifesto | Common Dreams

> Palantir are Enemies of humanity.

#palantir #manifesto #technofascism #alexkarp #karp #readme #politics #AIauthoritarian #Americentric #fckusa #boycottamericantech

https://www.commondreams.org/news/palantir-technofascist-manifesto-criticism

'One of The Scariest Things I Have Seen': Alarms Sound Over 'Technofascist' Palantir Manifesto | Common Dreams

> Palantir are Enemies of humanity.

#palantir #manifesto #technofascism #alexkarp #karp #readme #politics #AIauthoritarian #Americentric #fckusa #boycottamericantech

https://www.commondreams.org/news/palantir-technofascist-manifesto-criticism

'One of The Scariest Things I Have Seen': Alarms Sound Over 'Technofascist' Palantir Manifesto | Common Dreams

> Palantir are Enemies of humanity.

#palantir #manifesto #technofascism #alexkarp #karp #readme #politics #AIauthoritarian #Americentric #fckusa #boycottamericantech

https://www.commondreams.org/news/palantir-technofascist-manifesto-criticism

'One of The Scariest Things I Have Seen': Alarms Sound Over 'Technofascist' Palantir Manifesto | Common Dreams

> Palantir are Enemies of humanity.

#palantir #manifesto #technofascism #alexkarp #karp #readme #politics #AIauthoritarian #Americentric #fckusa #boycottamericantech

https://www.commondreams.org/news/palantir-technofascist-manifesto-criticism

In unserem neuen #readme-Interview berichten Carolin Fleischer-Heininger vom #DIJTokyo und Kevin Schumacher-Shoji von der #LMU, wie in der japanischen Literatur kulturelle Bedeutungen beim Übersetzen verloren gehen oder neu entstehen können.

🔗 Zum Interview: https://gab.hypotheses.org/22431

#Buchverlosung 🎁 | Unter allen, die diesen Beitrag hier, bei BlueSky, Instagram, Facebook oder LinkedIn bis zum 22.04.2026 kommentieren oder liken, verlosen wir ein Printexemplar des Buches!

In unserem neuen #readme-Interview berichten Carolin Fleischer-Heininger vom #DIJTokyo und Kevin Schumacher-Shoji von der #LMU, wie in der japanischen Literatur kulturelle Bedeutungen beim Übersetzen verloren gehen oder neu entstehen können.

🔗 Zum Interview: https://gab.hypotheses.org/22431

#Buchverlosung 🎁 | Unter allen, die diesen Beitrag hier, bei BlueSky, Instagram, Facebook oder LinkedIn bis zum 22.04.2026 kommentieren oder liken, verlosen wir ein Printexemplar des Buches!

In unserem neuen #readme-Interview berichten Carolin Fleischer-Heininger vom #DIJTokyo und Kevin Schumacher-Shoji von der #LMU, wie in der japanischen Literatur kulturelle Bedeutungen beim Übersetzen verloren gehen oder neu entstehen können.

🔗 Zum Interview: https://gab.hypotheses.org/22431

#Buchverlosung 🎁 | Unter allen, die diesen Beitrag hier, bei BlueSky, Instagram, Facebook oder LinkedIn bis zum 22.04.2026 kommentieren oder liken, verlosen wir ein Printexemplar des Buches!

In unserem neuen #readme-Interview berichten Carolin Fleischer-Heininger vom #DIJTokyo und Kevin Schumacher-Shoji von der #LMU, wie in der japanischen Literatur kulturelle Bedeutungen beim Übersetzen verloren gehen oder neu entstehen können.

🔗 Zum Interview: https://gab.hypotheses.org/22431

#Buchverlosung 🎁 | Unter allen, die diesen Beitrag hier, bei BlueSky, Instagram, Facebook oder LinkedIn bis zum 22.04.2026 kommentieren oder liken, verlosen wir ein Printexemplar des Buches!

🚨 ALERT: Yet another earth-shattering revelation from the tech elite—putting your docs in a repo is the ultimate AI hack! 🤖✨ Because obviously, the real breakthrough in AI isn't autonomous vehicles or natural language processing—it's making sure your #README.md is under version control. 🙄
https://www.dein.fr/posts/2026-03-13-its-time-to-move-your-docs-in-the-repo #technews #AIhacks #versioncontrol #md #innovation #HackerNews #ngated

🚨 ALERT: Yet another earth-shattering revelation from the tech elite—putting your docs in a repo is the ultimate AI hack! 🤖✨ Because obviously, the real breakthrough in AI isn't autonomous vehicles or natural language processing—it's making sure your #README.md is under version control. 🙄
https://www.dein.fr/posts/2026-03-13-its-time-to-move-your-docs-in-the-repo #technews #AIhacks #versioncontrol #md #innovation #HackerNews #ngated

🚨 ALERT: Yet another earth-shattering revelation from the tech elite—putting your docs in a repo is the ultimate AI hack! 🤖✨ Because obviously, the real breakthrough in AI isn't autonomous vehicles or natural language processing—it's making sure your #README.md is under version control. 🙄
https://www.dein.fr/posts/2026-03-13-its-time-to-move-your-docs-in-the-repo #technews #AIhacks #versioncontrol #md #innovation #HackerNews #ngated

🚨 ALERT: Yet another earth-shattering revelation from the tech elite—putting your docs in a repo is the ultimate AI hack! 🤖✨ Because obviously, the real breakthrough in AI isn't autonomous vehicles or natural language processing—it's making sure your #README.md is under version control. 🙄
https://www.dein.fr/posts/2026-03-13-its-time-to-move-your-docs-in-the-repo #technews #AIhacks #versioncontrol #md #innovation #HackerNews #ngated

https://www.europesays.com/ie/372593/ Money and motoring: There is a never-ending appetite to charge car owners for everything – The Journal ##Motoring ##transport #Analysis #BreakingNews #BreakingNews #ClimateChange #column #dublin #Éire #FeaturedNews #FeaturedNews #Headlines #IE #Ireland #LatestNews #LatestNews #M50 #MainNews #MainNews #MotorTax #News #Opinion #PaddyComyn #ReadMe #TopStories #TopStories

"The people best positioned to configure AI agents like Claude Code aren't engineers. They're technical writers.

It's a bold claim, so let me back it up.

Here's a file that powers an AI agent:

AGENTS.md

# AGENTS.md — API Documentation Repository

## Workflow Rules

- Human review required for API reference changes
- Style guide compliance checked automatically via CI
- Maximum 3 AI revision cycles before human takeover

## Escalation

- Writer agent fails after 3 attempts → human writer takes over
- Reviewer agent flags accuracy concern → SME review required
Markdown syntax, structured headings, rules about workflows and handoffs. If you've written a README, a style guide, or onboarding documentation, this looks familiar because it that's effectively what it is. The files that configure AI agents are Markdown files with structured frontmatter. They're documentation.

The difference is the audience: instead of a human colleague, you're writing for an AI model that's highly knowledgeable but has zero institutional memory. The challenge is one technical communicators already navigate: deciding what to include, how to structure it, and what level of detail serves the reader.

So what kinds of files are involved?"

https://instructionmanuel.com/agent-configs-are-docs

#TechnicalWriting #AI #LLMs #AIAgents #AgenticAI #TechnicalCommunication #Markdown #README

"The people best positioned to configure AI agents like Claude Code aren't engineers. They're technical writers.

It's a bold claim, so let me back it up.

Here's a file that powers an AI agent:

AGENTS.md

# AGENTS.md — API Documentation Repository

## Workflow Rules

- Human review required for API reference changes
- Style guide compliance checked automatically via CI
- Maximum 3 AI revision cycles before human takeover

## Escalation

- Writer agent fails after 3 attempts → human writer takes over
- Reviewer agent flags accuracy concern → SME review required
Markdown syntax, structured headings, rules about workflows and handoffs. If you've written a README, a style guide, or onboarding documentation, this looks familiar because it that's effectively what it is. The files that configure AI agents are Markdown files with structured frontmatter. They're documentation.

The difference is the audience: instead of a human colleague, you're writing for an AI model that's highly knowledgeable but has zero institutional memory. The challenge is one technical communicators already navigate: deciding what to include, how to structure it, and what level of detail serves the reader.

So what kinds of files are involved?"

https://instructionmanuel.com/agent-configs-are-docs

#TechnicalWriting #AI #LLMs #AIAgents #AgenticAI #TechnicalCommunication #Markdown #README

"The people best positioned to configure AI agents like Claude Code aren't engineers. They're technical writers.

It's a bold claim, so let me back it up.

Here's a file that powers an AI agent:

AGENTS.md

# AGENTS.md — API Documentation Repository

## Workflow Rules

- Human review required for API reference changes
- Style guide compliance checked automatically via CI
- Maximum 3 AI revision cycles before human takeover

## Escalation

- Writer agent fails after 3 attempts → human writer takes over
- Reviewer agent flags accuracy concern → SME review required
Markdown syntax, structured headings, rules about workflows and handoffs. If you've written a README, a style guide, or onboarding documentation, this looks familiar because it that's effectively what it is. The files that configure AI agents are Markdown files with structured frontmatter. They're documentation.

The difference is the audience: instead of a human colleague, you're writing for an AI model that's highly knowledgeable but has zero institutional memory. The challenge is one technical communicators already navigate: deciding what to include, how to structure it, and what level of detail serves the reader.

So what kinds of files are involved?"

https://instructionmanuel.com/agent-configs-are-docs

#TechnicalWriting #AI #LLMs #AIAgents #AgenticAI #TechnicalCommunication #Markdown #README

"The people best positioned to configure AI agents like Claude Code aren't engineers. They're technical writers.

It's a bold claim, so let me back it up.

Here's a file that powers an AI agent:

AGENTS.md

# AGENTS.md — API Documentation Repository

## Workflow Rules

- Human review required for API reference changes
- Style guide compliance checked automatically via CI
- Maximum 3 AI revision cycles before human takeover

## Escalation

- Writer agent fails after 3 attempts → human writer takes over
- Reviewer agent flags accuracy concern → SME review required
Markdown syntax, structured headings, rules about workflows and handoffs. If you've written a README, a style guide, or onboarding documentation, this looks familiar because it that's effectively what it is. The files that configure AI agents are Markdown files with structured frontmatter. They're documentation.

The difference is the audience: instead of a human colleague, you're writing for an AI model that's highly knowledgeable but has zero institutional memory. The challenge is one technical communicators already navigate: deciding what to include, how to structure it, and what level of detail serves the reader.

So what kinds of files are involved?"

https://instructionmanuel.com/agent-configs-are-docs

#TechnicalWriting #AI #LLMs #AIAgents #AgenticAI #TechnicalCommunication #Markdown #README

"The people best positioned to configure AI agents like Claude Code aren't engineers. They're technical writers.

It's a bold claim, so let me back it up.

Here's a file that powers an AI agent:

AGENTS.md

# AGENTS.md — API Documentation Repository

## Workflow Rules

- Human review required for API reference changes
- Style guide compliance checked automatically via CI
- Maximum 3 AI revision cycles before human takeover

## Escalation

- Writer agent fails after 3 attempts → human writer takes over
- Reviewer agent flags accuracy concern → SME review required
Markdown syntax, structured headings, rules about workflows and handoffs. If you've written a README, a style guide, or onboarding documentation, this looks familiar because it that's effectively what it is. The files that configure AI agents are Markdown files with structured frontmatter. They're documentation.

The difference is the audience: instead of a human colleague, you're writing for an AI model that's highly knowledgeable but has zero institutional memory. The challenge is one technical communicators already navigate: deciding what to include, how to structure it, and what level of detail serves the reader.

So what kinds of files are involved?"

https://instructionmanuel.com/agent-configs-are-docs

#TechnicalWriting #AI #LLMs #AIAgents #AgenticAI #TechnicalCommunication #Markdown #README

I've published my first Action to the GitHub Marketplace. It's a very simple tool (as all the best ones are!) that takes your repo's README and converts it to HTML for use in a GitHub Pages website. It scratched a very particular itch for me, but it might be useful to other people, too.

https://dev.to/davorg/your-readme-is-already-a-website-dg7

#githubpages #githubactions #readme #website

I've published my first Action to the GitHub Marketplace. It's a very simple tool (as all the best ones are!) that takes your repo's README and converts it to HTML for use in a GitHub Pages website. It scratched a very particular itch for me, but it might be useful to other people, too.

https://dev.to/davorg/your-readme-is-already-a-website-dg7

#githubpages #githubactions #readme #website

I've published my first Action to the GitHub Marketplace. It's a very simple tool (as all the best ones are!) that takes your repo's README and converts it to HTML for use in a GitHub Pages website. It scratched a very particular itch for me, but it might be useful to other people, too.

https://dev.to/davorg/your-readme-is-already-a-website-dg7

#githubpages #githubactions #readme #website

I've published my first Action to the GitHub Marketplace. It's a very simple tool (as all the best ones are!) that takes your repo's README and converts it to HTML for use in a GitHub Pages website. It scratched a very particular itch for me, but it might be useful to other people, too.

https://dev.to/davorg/your-readme-is-already-a-website-dg7

#githubpages #githubactions #readme #website

https://www.europesays.com/ie/361060/ I set my novel in a two-tier housing nightmare that came true #BreakingNews #BreakingNews #EdelCoffey #Éire #FeaturedNews #FeaturedNews #Headlines #HouseRules #HousingCrisis #IE #Ireland #LatestNews #LatestNews #MainNews #MainNews #News #Opinion #PropertyCrisis #ReadMe #SlidingDoors #TopStories #TopStories #voices

The blog on my new website is now powered by Elfsight!

This makes the integration cleaner and easier for me to use.
Plus you don't need to go to Codeberg for it.

I'm really happy with this tool so far!

Don't worry if you prefered Codeberg as my blog plattform.
I'm still gonna write my Blogs in README files in the Blog Repository, I'm just gonna use a different tool to display the same thing on my website.

#blog #intergration #elfsight #website #personalwebsite #personalblog #codeberg #readme #markdown

#README: Brief #introduction :logo_epfl: :epfl_sti:
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 :logo_epfl: :epfl_sti:
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

Проброс сайта, не имеющего глобального IP-а́дреса, из локальной сети на свой сервер в Интернете (обратный прокси) через сеть Yggdrasil
https://multed.com/2024/04/03/nginx-and-yggdrasill.html

#HTTP #сайт #IP #IPv4 #IPv6 #IP_адрес #сеть #LAN #LAN #сервер #VPS #VDS #Интернет #Yggdrasil #nginx #proxy #reverseproxy #reverse_proxy #publicpeer #сисадмин #лайфхак #readme

@blyxyas I by no means am comparing between your #developer #chops to mine. But I can honestly relate to your comment about the #readme #comment. There have been #manytimes when I came up with #newideas only to find #something my past #self created that I completely forgot about. Realizing that it wasn’t a new idea after all Going through the #code and the #Documentation left me #surprised and #feeakedout

Gryph the Gryphon with other various creatures

#Gryphon #Gryphons #Gryphonwriting #verykind #verycute #playful #verynice #lovely #social #mythicalcreature

#writing #text #fantasy #thoughts #lotsoftext #information #readme

Gryph the Gryphon with other various creatures

#Gryphon #Gryphons #Gryphonwriting #verykind #verycute #playful #verynice #lovely #social #mythicalcreature

#writing #text #fantasy #thoughts #lotsoftext #information #readme

🔴 🚀 Nouveauté chez Arawa ! Nous sommes ravis d'annoncer la publication de notre guide 🇫🇷 pour les utilisateurs de #Nextcloud sur #GitHub ! 📚 Disponible sous licence CC BY-NC-SA, ce guide couvre déjà Nextcloud 27 et 28. 🌐 N'hésitez pas à le consulter et à le partager ! 🧩 Vos contributions sont les bienvenues (merci de lire le #ReadMe de la page GitHub avant de contribuer).
👋 @nextcloud
#️⃣ #OpenSource #LogicielsLibres #UserGuide #CreativeCommons #CCBYNCSA
https://github.com/arawa/guides-utilisateurs-nextcloud

@hroncok You can do it with the nifty https://pypi.org/project/cogapp/

For example:

https://github.com/hugovk/norwegianblue/blob/main/README.md?plain=1

https://github.com/hugovk/norwegianblue/blob/fcb990eec7b96c950cfec7e6a2a4f0351539a221/tox.ini#L30

#Python #README #cog

🎨💻 Behold, the revolutionary library of bubble-shaped icons to elevate your developer street cred! Because, clearly, your coding prowess is defined by the cuteness of your #GitHub #README. 🙄✨
https://github.com/YuheshPandian/ICONIC #bubbleicons #developercred #designtrends #codinghumor #HackerNews #ngated

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)

The #README is written and translated into English. Next step is to initialize my directory and set up #git with the necessary information for #Codeberg.

My excitement is growing 🤩

The #README is written and translated into English. Next step is to initialize my directory and set up #git with the necessary information for #Codeberg.

My excitement is growing 🤩

Hot take: I tried the opposite of TDD.

I wrote the README first.
Then forced the code to obey it.

A README that is also a runnable literate Haskell script:

./4_ch.md

No build system. Just runghc.

It turns out README-driven design is amazing for small tools and teaching (or generating code).

It breaks for big systems, which is how you know when to stop.

Read more: https://gopher.someodd.zip/0//phlog/4_ch.gopher.md

#haskell #programming #readme #tdd #dev

Hot take: I tried the opposite of TDD.

I wrote the README first.
Then forced the code to obey it.

A README that is also a runnable literate Haskell script:

./4_ch.md

No build system. Just runghc.

It turns out README-driven design is amazing for small tools and teaching (or generating code).

It breaks for big systems, which is how you know when to stop.

Read more: https://gopher.someodd.zip/0//phlog/4_ch.gopher.md

#haskell #programming #readme #tdd #dev

Hot take: I tried the opposite of TDD.

I wrote the README first.
Then forced the code to obey it.

A README that is also a runnable literate Haskell script:

./4_ch.md

No build system. Just runghc.

It turns out README-driven design is amazing for small tools and teaching (or generating code).

It breaks for big systems, which is how you know when to stop.

Read more: https://gopher.someodd.zip/0//phlog/4_ch.gopher.md

#haskell #programming #readme #tdd #dev

Hot take: I tried the opposite of TDD.

I wrote the README first.
Then forced the code to obey it.

A README that is also a runnable literate Haskell script:

./4_ch.md

No build system. Just runghc.

It turns out README-driven design is amazing for small tools and teaching (or generating code).

It breaks for big systems, which is how you know when to stop.

Read more: https://gopher.someodd.zip/0//phlog/4_ch.gopher.md

#haskell #programming #readme #tdd #dev