#readme — Public Fediverse posts

README врёт: как я сделал open‑source линтер, который сверяет документацию с реальным репозиторием

README редко ломается в один момент. Обычно он просто постепенно перестаёт соответствовать проекту: переименовали команду, перенесли файл, удалили .env.example , сменили package manager — а инструкция осталась прежней. В итоге новый пользователь копирует команду из README и получает ошибку. Разработчик же часто узнаёт об устаревшей документации только после issue, сообщения коллеги или неудачного деплоя. Мне стало интересно: можно ли автоматически находить хотя бы часть таких расхождений, не выполняя команды из README и не отправляя исходный код в LLM? Так появился RealityLint — open‑source CLI, который статически сверяет проверяемые утверждения из README с реальным состоянием репозитория.

https://habr.com/ru/articles/1072076/

#RealityLint #README #Python #GitHubActions #CICD #opensource #статическийанализ #документация #тестирование #линтер

In a valiant attempt to turn #GitHub into a magical 'Book of Spells' for #AI nerds, this so-called "Little Book" is just another glorified #README file with delusions of grandeur. 🤦‍♂️ Forget Hogwarts; if you want to learn reinforcement learning, prepare to navigate a labyrinth of GitHub menus instead. 🧙‍♂️📚
https://github.com/alxndrTL/little-book-rl/ #LittleBook #reinforcementLearning #techHumor #HackerNews #ngated

Recently I was asked if #syslog_ng supports #Ubuntu 26.04 (Ubuntu Resolute).

Yes, and with the arrival of the syslog-ng 4.12.0 release we also provide ready-to-use packages for it. The release notes mention it, and info is in the #Readme on #GitHub.

https://www.syslog-ng.com/community/b/blog/posts/syslog-ng-4-12-0-available-for-ubuntu-26-04-resolute

GitHub стал однообразнее после появления ChatGPT?

После появления ChatGPT и массового распространения GitHub Copilot, Cursor, Claude Code, Windsurf и других AI-инструментов разработка стала заметно быстрее. Код, тесты, README, комментарии и небольшие utility-функции теперь можно получить за секунды. Но вместе с этим появился менее очевидный вопрос: если миллионы разработчиков используют похожие модели и похожие промпты, не становится ли открытый код более однообразным? В этой статье я проверяю эту гипотезу на данных GitHub за 2019-2025 годы: через GH Archive, BigQuery, commit messages, README, имена функций и собственный GitHub Uniformity Index. К исследованию

https://habr.com/ru/articles/1055596/

#GitHub #open_source #ChatGPT #GitHub_Copilot #BigQuery #GH_Archive #LLM #анализ_данных #commit_messages #README

Matthias Uhl vom #MaxWeberNetzwerkOsteuropa berichtet in unserem #readme-Interview über sein neues Buch „Wie stark ist Russland wirklich? Die Wahrheit über Putins Militärmacht“. Darin untersucht er die Stärken und Schwächen der russischen Armee.

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

#Buchverlosung 🎁 | Unter allen, die den oben stehenden Beitrag hier, bei Instagram, Bluesky, Facebook oder LinkedIn bis zum 10.07.2026 kommentieren oder liken, verlosen wir ein Printexemplar des Buches!

RE: https://fosstodon.org/@Cockpit/116811005398344842

Nice.

Feature suggestion for GitHub, if any product managers from GH are poking around:

Feature the README first, don't bury it under the file display.

How many people, going to github/org/project-name are looking to pick a specific file out of the project tree rather than reading the README? Few, I suspect. Certainly fewer than are going there to find out more about the project.

Stop making people scroll so far just to get to the README.

(This also applies to other git forges... Putting the README first and better UX design could be a nice differentiator for non-GH forges.)

#GitHub #README #Documentation #UX

If the things that one can eat are "edibles", then the things that one can read must clearly be "readables".

#eatme #readme

Почему ваш GitHub — лучший лендинг, который можно сделать

Как README превращается в PR-актив: структура, нарратив, quickstart Когда кто-то впервые сталкивается с техническим продуктом, он открывает репозиторий. Инфлюенс, которому прислали питч, инвестор после дежурного «посмотрите наш продукт» делает то же самое, и разработчик, который наткнулся на тред в X, идёт туда же. Репозиторий - первая точка касания для аудитории с реальным весом: инженеры, тимлиды, CTO ранних стартапов, контрибьюторы в опенсорс. Они формируют репутацию инструмента до того, как о нём напишут медиа, их мнение распространяется быстрее любого пресс-релиза.

https://habr.com/ru/articles/1049528/

#github #readme #репозиторий #стартап #звезды #пиар #it #маркетинг

In unserem neuen #readme-Interview beschreibt Yuliya von Saal, wie Kinder im besetzten Belarus den Zweiten Weltkrieg und die Nachkriegszeit erlebten und dabei schon früh Verantwortung übernahmen, Überlebensstrategien entwickelten oder Angehörige versorgten.

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

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

Обсуждения неудачных примеров 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

'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!

🚨 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

"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

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

All of my R package README's have been updated. #R #RStats #GitHub #Copilot #README

🚀 Wow, another "revolutionary" #installation #script for the 17 people who actually use CachyOS! 🤯 Just what the world needed—a #README.md longer than the actual code. #GitHub #Copilot better be ready for this masterpiece! 😂💻
https://github.com/mroboff/omarchy-on-cachyos #CachyOS #humor #HackerNews #ngated

Ever downloaded a dataset and wondered: "what am I looking at here?" You’re not alone. That’s why README files are so important.

A README is like a quick-start guide to your research data. Its the key to #reproducibility, reuse & maximum impact.

Learn more ➡️ https://bit.ly/Whats-a-README

#biology #opendata #openaccess #openscience #README #datasharing #dataset

README files are a simple but crucial component of data sharing. Without a #README, the benefits of #opendata — improved understanding, reproducibility, trust, and attention — are moot. That’s because data cannot be interpreted, validated, or reused without certain key details that a README provides.

Learn how to maximize the impact of your dataset with an effective README ➡️ https://blog.datadryad.org/2025/09/09/whats-in-a-readme-why-your-readme-matters-and-how-to-create-the-best-one-possible/

#biology #openaccess #openscience #datasharing #dataset

If you're interested in experimenting with #XML & #XSLT to style a website I recommend Evan Widloski's project:
https://github.com/Evidlo/xsl-website
(his wildcard template to ignore html tags was super useful).
Paco Coursey also has a cool repo:
https://github.com/pacocoursey/xslt
And the #GrugBrained #ReadMe is worth the price of admission! Complexity very, very bad.

🎉 Behold, the "Revolutionary" AGENTS.md: because plain, old READMEs just aren't good enough for our majestic robot overlords! Instead of cluttering up a #README with trivial human details, let's roll out the red carpet for #AI with a baffling set of #instructions as clear as mud. Now, your #coding #agent can finally navigate your project while you helplessly wonder why it won't just read what's already there. 🤖🚀
https://agents.md/ #Revolutionary #AGENTS.md #HackerNews #ngated

@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

Примеры для вдохновения — оформление README

Документация играет важную роль в эффективной работе, особенно в условиях крупных и сложных инфраструктур. Она не только облегчает понимание существующих решений, но и ускоряет процесс интеграции новых технологий. Поэтому, например, важно иметь

https://habr.com/ru/companies/mws/articles/919184/

#mws #readme #readmemd #документация #документирование

🚀✨ Behold, the Magnum Opus on Asyncio: a #GitHub #README #masterpiece that promises to enlighten you with its impenetrable wall of text and zero actual code examples. 🤯💡 Perfect for those who prefer their #software #education as #dry and verbose as your Aunt Mabel's fruitcake. 🍰🔍
https://github.com/anordin95/a-conceptual-overview-of-asyncio/blob/main/readme.md #Asyncio #Humor #HackerNews #ngated