Generate bufarrow-style READMEs from AGENTS.md, manifest files, and user details.
npx skills add https://github.com/loicalleyne/esquisse --skill write-readme-loicalleyne
Please help me install this Agent Skill. Skill: write-readme Source: https://github.com/loicalleyne/esquisse/tree/main/skills/write-readme Command: npx skills add https://github.com/loicalleyne/esquisse --skill write-readme-loicalleyne
This Skill automates the creation of a README in the bufarrow style, saving developers time and ensuring a consistent, professional appearance for their projects.
Run the 'write-readme' skill and follow the prompts to generate your README in bufarrow style.
High-intent search queries and answers about installing and using this skill.
To generate a bufarrow-style README, the skill automates initialization, metadata extraction, user interviews, and draft synthesis using your project details and manifest files. It outputs a professional Markdown document with a punchy value proposition and curated reference section.
The bufarrow style is a specific README format featuring a punchy value proposition, a use-case table, quick-start patterns, and a curated reference section. It ensures a consistent, professional appearance for project documentation across different languages.
Yes, creating markdown READMEs with this tool requires input from an AGENTS.md file, manifest files, and user-provided details. These inputs drive the metadata extraction and draft synthesis processes to ensure accurate project documentation.
Yes, you can update existing READMEs to align with bufarrow style guidelines using the tool's update mode. It adapts your current project documentation to include the required use-case table, quick-start patterns, and curated reference section.
The README generator customizes its output by adapting badges and install sections based on the specific project type and language. This ensures the generated markdown documentation remains relevant and accurate for your particular development environment.
Xander-26CodeGenerate and improve README files from project metadata and templates.
Moshe-shipGenerate Arabic documentation from Python, JavaScript, and TypeScript codebases.
bug-opsInitialize Rust project directories, rules, and knowledge base files.
Andreicr1Generate HTML, Markdown, and PDF API documentation from OpenAPI specs or code comments.
