readme-style
OfficialStandardize README files for Sun Lab projects.
AuthorSun-Lab-NBB
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill ensures that all README.md files adhere to the Sun Lab's established conventions, improving consistency, readability, and maintainability across projects.
Core Features & Use Cases
- Standardized Structure: Enforces a consistent section order and hierarchy.
- Style Guide Adherence: Guides writing style, tense, and use of notes/warnings for PyPI compatibility.
- Codebase Cross-referencing: Mandates verification of technical content against the actual codebase.
- Use Case: When creating a new project or updating an existing one, use this Skill to generate or refine its README.md file to meet all Sun Lab standards, including badges, section templates, and style guidelines.
Quick Start
Apply Sun Lab README conventions to the README.md file in the current directory.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 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: readme-style Download link: https://github.com/Sun-Lab-NBB/ataraxis/archive/main.zip#readme-style 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 471,000+ vetted skills library on demand.