01 / DETECT
Read the project
The CLI uses your Git remote, configured author, license, and project files to suggest smart defaults.
The tiny CLI for better project docs
A README before your ideas go cold.
Lightning-Readme reads the useful bits from your project, asks only what it needs, and turns the answers into a clean Markdown starting point.
One guided command
Preview before write
Kotlin powered
$ readme-gen
› Enter Project Name: pixel-sorter
› Enter Description: A tiny image sorting tool.
› Enter Author Name: Eli Nelson
› Enter License: MIT
README PREVIEW
# pixel-sorter
[ Kotlin ] [ Java ]
A tiny image sorting tool.
## Project Info
[ Kotlin ] [ Java ]
A tiny image sorting tool.
## Project Info
› Write this to README.md? Y
README.md successfully created
A sensible little workflow
From blank file to useful first draft.
No sprawling setup. No template archaeology. Just the details every good project page needs to get started.
02 / REVIEW
Confirm the details
Accept the defaults or make a quick correction, then inspect the full Markdown preview before anything changes.
03 / WRITE
Write README.md
Approve the final prompt and Lightning-Readme creates a structured README that is ready for your finishing touches.
Less ceremony, more shipping
The useful parts are built in.
Smart project defaults
Project name, author, license, and language badges are inferred wherever possible, so the prompts feel helpful—not repetitive.
Review before writing
See the generated Markdown and explicitly approve the file write.
Works where you work
The installer detects Linux, macOS, and Windows shell environments.
Ready when you are
One command. Then create.
Run the installer, move into any project, and launch readme-gen. Keep it current with --update, or remove it with --uninstall.
Install with curlsh
curl -fsSL https://raw.githubusercontent.com/Papaya-Voldemort/Lightning-Readme/master/install.sh | sh
Update or uninstallsh
readme-gen --update
readme-gen --uninstall