readme

Name: readme
Author: AdamBien

40stars10forks

How to install readme?

adambien/airails/readme

$npx -y skills add AdamBien/airails --skill readme

Installs into the current project.

Summary

Write and refine README.md files for software projects targeting advanced developers. Use when asked to create, write, generate, update, refine, or review a README or README.md file. Triggers on "create a README", "write README", "update README", "review README", "generate README

Files · 1

View on GitHub

SKILL.md

1	# README Writing
2
3	## Style
4
5	- Target audience: advanced developers. Assume familiarity with tools, frameworks, and patterns.
6	- Use precise, concise language. Every sentence must convey information.
7	- Use imperative form for instructions (e.g., "Run the build" not "You can run the build").
8	- Avoid generic adjectives: "simple", "lightweight", "powerful", "easy-to-use", "robust".
9	- Avoid the term "Orchestrates" — use more specific alternatives (e.g., "coordinates", "delegates to", "calls").
10
11	## Structure
12
13	- Keep READMEs brief and to the point — favor clarity over completeness.
14	- Do NOT include detailed project structure (file/folder tree listings). High-level module descriptions are acceptable.
15	- Do NOT list REST resources or API endpoints in READMEs.
16	- If modules are listed, provide links to their directories or documentation.
17	- Use Mermaid for diagrams. GitHub renders Mermaid natively in markdown.
18
19	## Content
20
21	- Lead with what the project does in one or two sentences.
22	- Include only essential sections: purpose, prerequisites, build/run instructions, configuration (if non-obvious).
23	- Omit sections that add no value (e.g., "Contributing", "License" boilerplate) unless explicitly requested.
24
25	## Example skeleton
26
27	```markdown
28	# Project Name
29
30	One or two sentences: what it does and why.
31
32	## Prerequisites
33
34	Java 25+, Docker
35
36	## Build and Run
37
38	\`\`\`
39	mvn clean package
40	java -jar target/app.jar
41	\`\`\`
42
43	## Configuration
44
45	Only if non-obvious.
46	```

People who liked this also viewed

6 picks

Type

readme

40stars10forks

View on GitHub

How to install readme?

adambien/airails/readme

$npx -y skills add AdamBien/airails --skill readme

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# README Writing
2
3	## Style
4
5	- Target audience: advanced developers. Assume familiarity with tools, frameworks, and patterns.
6	- Use precise, concise language. Every sentence must convey information.
7	- Use imperative form for instructions (e.g., "Run the build" not "You can run the build").
8	- Avoid generic adjectives: "simple", "lightweight", "powerful", "easy-to-use", "robust".
9	- Avoid the term "Orchestrates" — use more specific alternatives (e.g., "coordinates", "delegates to", "calls").
10
11	## Structure
12
13	- Keep READMEs brief and to the point — favor clarity over completeness.
14	- Do NOT include detailed project structure (file/folder tree listings). High-level module descriptions are acceptable.
15	- Do NOT list REST resources or API endpoints in READMEs.
16	- If modules are listed, provide links to their directories or documentation.
17	- Use Mermaid for diagrams. GitHub renders Mermaid natively in markdown.
18
19	## Content
20
21	- Lead with what the project does in one or two sentences.
22	- Include only essential sections: purpose, prerequisites, build/run instructions, configuration (if non-obvious).
23	- Omit sections that add no value (e.g., "Contributing", "License" boilerplate) unless explicitly requested.
24
25	## Example skeleton
26
27	```markdown
28	# Project Name
29
30	One or two sentences: what it does and why.
31
32	## Prerequisites
33
34	Java 25+, Docker
35
36	## Build and Run
37
38	\`\`\`
39	mvn clean package
40	java -jar target/app.jar
41	\`\`\`
42
43	## Configuration
44
45	Only if non-obvious.
46	```

People who liked this also viewed

6 picks

Type