ff-project-readme
CommunityAutomates FassadenFix READMEs with CI branding.
AuthorFassadenFix
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill centralizes the creation and validation of FassadenFix-compliant README files for projects, skills, and internal tools, ensuring brand consistency and CI alignment.
Core Features & Use Cases
- Template-driven README generation for standard, skill, web, and API formats.
- Smart content merging to preserve user-provided information while applying FassadenFix branding.
- CI conformity validation to verify logo usage, colors, badges, and required sections.
- Use Case: Kick off a new FassadenFix project and generate a ready-to-publish README that matches the corporate design.
Quick Start
Run the generator to create a README by specifying the project name and template type, then optionally save to a file:
- python scripts/generate_readme.py "<project-name>" --type standard
- python scripts/generate_readme.py "<project-name>" --type skill --output README.md
Dependency Matrix
Required Modules
yaml
Components
scriptsreferences
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: ff-project-readme Download link: https://github.com/FassadenFix/FaFi/archive/main.zip#ff-project-readme Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.