git404hub

what is easyreadme fr?

xander-26code/easyreadme — explained in plain English

Analysis updated 2026-05-18

21PythonAudience · developerComplexity · 2/5Setup · easy

tl;dr

A Claude Code skill that writes accurate READMEs by extracting real facts from your project instead of inventing them.

vibe map

mindmap
  root((easyReadme))
    What it does
      Claude Code skill
      Fact based README writer
      Marks unknowns as TODO
    Tech stack
      Python
      Claude Code
      Markdown templates
    Use cases
      Generate new README
      Improve existing README
      Audit for missing facts
      Validate finished README
    Audience
      Developers using Claude Code
      Cursor and Codex users
    Workflow
      Extract project facts
      Choose README shape
      Draft and validate

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

what do people make with this?

VIBE 1

Generate a first README for a new project based only on its actual files.

VIBE 2

Improve an existing README's structure and clarity without adding fake details.

VIBE 3

Audit a README to find missing sections or unverifiable claims before editing.

VIBE 4

Validate a drafted README for broken links, missing sections, or leftover TODOs.

what's the stack?

PythonClaude CodeMarkdown

how it stacks up fr

xander-26code/easyreadme0whitedev/detranspiler2951461586/mulerun-pool
Stars212121
LanguagePythonPythonPython
Setup difficultyeasyhardmoderate
Complexity2/54/53/5
Audiencedeveloperdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

how do i run it?

Difficulty · easy time til it works · 5min

Requires Claude Code or a compatible Agent Skills runtime, Python 3 only needed for the bundled analyze and validate scripts.

License terms are not stated in the explanation.

in plain english

Easy README is not an app you run yourself, it is a skill for Claude Code that teaches the AI a repeatable process for writing good README files based only on facts it can actually find in your project. Instead of guessing at features, commands, or licenses that do not exist, the skill instructs Claude to check the real project files first and mark anything it cannot confirm as a TODO rather than inventing it. The skill follows a five step process. First it clarifies who the README is for and what tone and location it should have. Then it extracts real facts from your project, looking at manifests, documentation, scripts, continuous integration files, deployment files, environment variable examples, and any images or media already in the repo. Next it picks a README structure appropriate to your project type, whether that is a command line tool, a library, an AI application, a backend API, a full product, or a self hosted app, drawing on a small library of proven README patterns. It then drafts the README using only verified facts, and finally it runs a validation pass that checks for broken local links, missing recommended sections, incorrect package commands, media path problems, and leftover TODO markers. The project bundles two small Python scripts to support this: one that analyzes a project folder and reports its structure and metadata as JSON, and one that validates a finished README against the actual project. Everything else is Markdown reference material, including the pattern library, quality checklist, and base template that Claude reads while working. This is meant for developers who already use Claude Code or a compatible agent runtime such as Cursor, Codex CLI, Gemini CLI, or OpenCode, and who want documentation generated or improved for a real repository without fabricated details. It can be installed with a single command through the Skills CLI, copied manually into a skills folder, or uploaded to Claude as a zip file.

prompts (copy fr)

prompt 1
Use easyReadme to generate a polished README for this project without inventing features.
prompt 2
Ask easyReadme to audit my current README and tell me what facts are missing.
prompt 3
Run the analyze_project.py script from this skill on my repository and show me the results.
prompt 4
Have easyReadme improve my README's structure while keeping every existing verified detail.

Frequently asked questions

what is easyreadme fr?

A Claude Code skill that writes accurate READMEs by extracting real facts from your project instead of inventing them.

What language is easyreadme written in?

Mainly Python. The stack also includes Python, Claude Code, Markdown.

What license does easyreadme use?

License terms are not stated in the explanation.

How hard is easyreadme to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is easyreadme for?

Mainly developer.

peek the repo → explain another one

This repo across BitVibe Labs

double-check against the repo, no cap.