skills.rest
benthamite
benthamiteCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

readme-gen

Generate GitHub-friendly README.md files from Emacs Lisp README.org manuals.

9|1|Updated Jul 19, 2022
Search Tags:#automation#documentation#github#readme#package#emacs lisp
One-click install
npx skills add https://github.com/benthamite/dotfiles --skill readme-gen-benthamite
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme-gen
Source: https://github.com/benthamite/dotfiles/tree/main/claude/skills/readme-gen
Command: npx skills add https://github.com/benthamite/dotfiles --skill readme-gen-benthamite

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation and updating of GitHub-friendly README.md files for Emacs Lisp packages, transforming comprehensive README.org manuals into concise, engaging overviews.

Core Features & Use Cases

  • Automated README Generation: Creates a README.md from an existing README.org manual.
  • Content Structuring: Organizes information into Title, Overview, Installation, Quick Start, Documentation, and optional Roadmap sections.
  • Dependency Inference: Automatically determines package owner and repository from git remotes for installation instructions.
  • Use Case: When you've just finished writing a detailed manual for your new Emacs Lisp package in README.org, use this Skill to generate a clean, professional README.md for your GitHub repository.

Quick Start

Generate a README.md for the current Emacs Lisp package using its README.org manual.

Frequently Asked Questions about readme-gen

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a README.md from a README.org for an Emacs Lisp package?▼

To generate a README.md from a README.org file, use this skill to extract package information and structure it into a GitHub-friendly overview with installation instructions inferred from git remotes.

Can I automatically infer installation instructions for an Elisp package from git remotes?▼

Yes, you can infer installation instructions from git remotes. The skill automatically determines the package owner and repository from your git configuration to populate the README.md installation section.

What sections are included when converting an org manual to a GitHub-friendly README?▼

Converting an org manual to a GitHub-friendly README structures the content into Title, Overview, Installation, Quick Start, Documentation, and optional Roadmap sections for clear presentation.

Does this README generation tool work without any external dependencies?▼

Yes, this README generation tool works without external dependencies. It operates independently to parse your existing README.org manual and output a formatted markdown file.

Why generate a separate README.md instead of just using the comprehensive org manual?▼

You generate a separate README.md to provide a concise, engaging overview specifically formatted for GitHub rendering, keeping the comprehensive org manual distinct for detailed documentation.

How do I update an existing README.md when my Emacs Lisp package manual changes?▼

To update an existing README.md, run the skill against your updated README.org manual. It regenerates the structured overview and quick start guide while preserving the GitHub-friendly format.

Related Skills

Explore More Software Engineering Skills→
plurigridplurigrid
60

emacs-info

Navigate and query Emacs Info manuals for Emacs, Elisp, and GNU tools.

Official
Intermediate
JylhisJylhis
1

elisp-package-publishing

Automates ELisp package publishing to MELPA and GNU ELPA with header checks, linting, and CI validation.

Community
Intermediate
captainflasmrcaptainflasmr
100

emacs-lisp-helper

Write, understand, and debug Emacs Lisp code with formatted docstrings.

Community
Intermediate
benthamitebenthamite
9

org-note

Create and update org-mode notes with Emacs Lisp slugification and ID generation.

Community
Intermediate