readme-generator
A skill for writing a new README.md or reorganising an existing one so a newcomer sees the pitch, the install step and one common example before the details.
Was der Skill vermittelt
A skill for writing a new README.md or reorganising an existing one so a newcomer sees the pitch, the install step and one common example before the details. In a Git repository it first syncs with origin, stashing tracked changes, and stops to ask if that fails. It then reads the manifest, licence, changelog, docs, tests and command-line definitions to collect facts with their source, backs up the old README, and writes the opening section followed by detail sections in a set order, keeping every original section. A self-check covers order, traced commands, working links and filler text. Missing facts become placeholders, and nothing is committed unless asked.
Funktionen
- Write a README from facts in the repository
- Restructure an existing README without dropping sections
- Back up the previous README before writing
- Check commands and links in the result
Überblick
- Herausgeber
- Luong Nguyen
- Tool
- Documentation
Funktioniert mit
Installation
- Führe diesen Befehl aus, um ihn zu Beliebiger Client hinzuzufügen:
npx skills@1.7.0 add https://github.com/luongnv89/skills --skill readme-generator
Was enthalten ist
- references/anti-slop-rules.md
- references/final-report.md
- references/landing-section.md
- references/section-templates.md
- references/step-reports.md
MCP-Server und Skills können Code auf deinem Rechner ausführen und auf deine Daten zugreifen. Prüfe den Quellcode, bevor du etwas installierst.
Details
| Angabe | Wert | Quelle |
|---|---|---|
| Typ | Skill | |
| Tool | Documentation | |
| Herausgeber | Luong Nguyen | Quelle |
| Offizieller Status | In der Dokumentation nicht angegeben | |
| Braucht API-Key oder Anmeldung | In der Dokumentation nicht angegeben | |
| Enthält Skripte | Nein | Quelle |
| Plattformen | In der Dokumentation nicht angegeben | |
| KI-Clients | Claude Code, Cursor, Codex, Devin Desktop | Quelle |
| Lizenz | MIT | Quelle |
| Preis | In der Dokumentation nicht angegeben | |
| Aktivität | Letzter Commit am 18. Nov. 2026147 GitHub-SterneKeine Download-Daten verfügbar (nicht auf npm oder PyPI) | Quelle |
| Links | Repository Website |
Auch zu finden unter: Documentation
Quellen
- GitHub-Repositorygithub.com/luongnv89/skills · Belegt: KI-Clients, Aktivität, Lizenz11. Nov. 2026
- Webseiteraw.githubusercontent.com · Belegt: Lizenz, Herausgeber19. Nov. 2026
- Skill-Datei (SKILL.md)github.com/luongnv89/skills19. Nov. 2026
- Ordner im Repository (readme-generator)github.com/luongnv89/skills · Belegt: Enthält Skripte19. Nov. 2026