agentsclimarketplace
Sign in

Create readme

Skill tuliosousapro/SaaS-blueprint/skills/create-readme

Intelligent README.md generation prompt that analyzes project documentation structure and creates comprehensive repository documentation. Scans ./ directory files and creates a README.md file for the project. Only used when creating a new repository. or when the README.md file is missing.From its SKILL.md

Install
npx -y skills add tuliosousapro/SaaS-blueprint --skill create-readme

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

  • 4 stars4 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

3.0 KB, 559 tokens by cl100k_base, as published. Nobody here has run it

Role

You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.

Task

Analyze the documentation files in the ./ directory. Follow these steps:

  1. Scan all the files in the ./ directory, like:

    • Architecture
    • Code_Exemplars
    • Coding_Standards
    • Project_Folder_Structure
    • Technology_Stack
    • Unit_Tests
    • Workflow_Analysis

  2. Create a README.md with the following sections:

Project Name and Description

  • Extract the project name and primary purpose from the documentation
  • Include a concise description of what the project does

Technology Stack

  • List the primary technologies, languages, and frameworks used
  • Include version information when available
  • Source this information primarily from the Technology_Stack file

Project Architecture

  • Provide a high-level overview of the architecture
  • Consider including a simple diagram if described in the documentation
  • Source from the Architecture file

Getting Started

  • Include installation instructions based on the technology stack
  • Add setup and configuration steps
  • Include any prerequisites

Project Structure

  • Brief overview of the folder organization
  • Source from Project_Folder_Structure file

Key Features

  • List main functionality and features of the project
  • Extract from various documentation files

Development Workflow

  • Summarize the development process
  • Include information about branching strategy if available
  • Source from Workflow_Analysis file

Coding Standards

  • Summarize key coding standards and conventions
  • Source from the Coding_Standards file

Testing

  • Explain testing approach and tools
  • Source from Unit_Tests file

Contributing

  • Guidelines for contributing to the project
  • Reference any code exemplars for guidance
  • Source from Code_Exemplars and copilot-instructions

License

  • Include license information if available, if not, ask user what license to use.

Format the README with proper Markdown, including:

  • Clear headings and subheadings
  • Code blocks where appropriate
  • Lists for better readability
  • Links to other documentation files
  • Badges for build status, version, etc. if information is available
  • Do not overuse emojis, and keep the readme concise and to the point.
  • Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate. If you find a logo or icon for the project, use it in the readme's header.

Keep the README concise yet informative, focusing on what new developers or users would need to know about the project.

What ships with it: 4 files

49.2 KB alongside SKILL.md

Assets/

Gives 0 of the 12 instructions most readme changelog skills give in 559 tokens

Counted across 446 of the 460 authors here whose files we hold, read 2026-09-06

  • Follow Keep a Changelog formatin 24 of 446
  • Collect commits since the last git tagin 15 of 446, across 13 files
  • Omit empty sectionsin 14 of 446
  • Put breaking changes first with migration stepsin 14 of 446
  • Include migration guidance for breaking changesin 11 of 446, across 10 files
  • Categorize commits by conventional commit prefixin 11 of 446
  • Mark breaking changes prominentlyin 10 of 446
  • Prepend the new entry to CHANGELOG.mdin 9 of 446
  • Highlight breaking changes with migration notesin 8 of 446, across 7 files
  • Classify changes into Keep a Changelog categoriesin 8 of 446, across 7 files
  • Group related commits into single entriesin 8 of 446
  • Write the changelog from commitsin 8 of 446

Said here and by no other author read

  • Scan all files in the project directory
  • Extract project name and purpose from documentation
  • List technologies, languages, and frameworks with versions
  • Summarize architecture with a diagram if described
  • Include installation, setup, and prerequisite steps
  • Summarize structure, workflow, standards, and testing

Grouped from the skills themselves: near-identical wordings counted once, and counted by distinct author, so one author publishing three of these counts once. Length counted with cl100k_base; the agent that loads this file may tokenize it differently.

Keep looking

Skills are one crate of 325,949. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.