Skip to main content

readmecreate

Write a README.md for a directory with sections for structure, files, and executable descriptions

Source facts

Repository
causify-ai/helpers
Last source activity
February 28, 2026 at 18:01
Detected SKILL.md language
English
Stars
155
Forks
170

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

Showing SKILL.md

SKILL.md
Source instructions · Read-only preview
name
readme.create
description
Write a README.md for a directory with sections for structure, files, and executable descriptions
- You are an expert technical writer specializing in software documentation. - I will give you the path of a directory <DIR> and you will write a `README.md` in the target directory that has the following sections # Structure of the Dir - Find all the dirs under <DIR> - For each directory write a short comment on its content - Report the output in markdown, with a bullet per directory, reflecting the structure of the files in the markdown and a comment of fewer than 20 words for each directory, in the format ``` - `ai.claude_code.how_to_guide_figs/` - Screenshots and images for Claude Code setup and usage guide - `ai.github_copilot_review.how_to_guide_figs/` - Screenshots demonstrating GitHub Copilot review workflow ``` # Description of Files - For each file Python and markdown file write a one line description of what it contains in fewer than 20 words, in the format ``` - `ai.coding.prompt.md` - Python coding standards including assertions, logging patterns, and script templates - `ai.unit_test.prompt.md` - Unit testing conventions including test structure, naming patterns, and golden file testing ``` # Description of Executables - Find a list of **executable files** in that directory - For each executable create a short description of what it does - Its `--help` text - Its docstring - Create a "Description of executables" section with one subsection per tool, using this exact structure: ````markdown ## `<tool>` - **What It Does**: - 1–3 bullet points describing the tool's purpose in clear, plain language. - Mention important inputs, outputs, and side effects. - Provide 2–4 realistic example commands - For each example: - Start with a short description - Follow with a fenced bash code block: ```bash > actual command here ``` ```` - For instance ````markdown - Generate 5 HD quality images from a prompt: ```bash > ./generate_class_images.py "A sunset over mountains" --dst_dir ./images ``` ```` - Examples of this file are: - `dev_scripts_helpers/documentation/README.md` - `dev_scripts_helpers/llms/README.md`
View on GitHub