Generate a ready-to-commit README.md from project metadata using a fixed Markdown template.
npx skills add https://github.com/tomzx/agents --skill write-readme-tomzx
Please help me install this Agent Skill. Skill: write-readme Source: https://github.com/tomzx/agents/tree/main/skills/write-readme Command: npx skills add https://github.com/tomzx/agents --skill write-readme-tomzx
Generates a complete README.md for a project using a fixed template, saving time and ensuring consistent documentation.
Run the skill with the target project directory to generate a complete README.md in the project root.
High-intent search queries and answers about installing and using this skill.
Auto-generate a README.md by running this skill on a project directory containing a license file and package manifest like package.json or Cargo.toml. It applies a fixed Markdown template to produce a formatted, ready-to-commit README.md at the project root.
README generation works across software languages and ecosystems. The skill reads available manifests such as go.mod, package.json, Cargo.toml, or pyproject.toml to extract project metadata and populate the template accordingly.
A template-driven README includes badges, feature lists, roadmap, setup instructions, and licensing info. It extracts project metadata from manifests and source files to populate these sections, outputting a complete README.md.
You can generate documentation for both new and existing repositories. The skill operates on a project directory containing manifests and license files, applying a fixed Markdown template to output a formatted README.md.
The best way to ensure consistent project documentation is using a fixed Markdown template applied to project metadata. This skill generates a standardized README.md with badges, setup instructions, and licensing info for every repository.
You need a license file and a package manifest to generate a README with this template approach. The skill operates on a project directory containing these files to extract metadata and output a formatted README.md.
allanninalGenerate project documentation from package manifests and code structure.
AGIBuildGenerate GitHub-native documentation templates for .NET projects.
auldsyababuaValidate Markdown files for syntax, links, and formatting standards.
KrystianYCSilvaCreate Markdown documentation with Mermaid diagrams and GFM tables.
