How-To Guides

repo-readme-generator: README and Docs Skill for Codex

Install repo-readme-generator for Codex to create or update README.md and documentation suites, including AGENTS.md, from verified repository evidence.

  • Builds README and optional docs suite with AGENTS.md
  • Evidence-only writing with explicit TBD for unknowns
  • Includes quick prompts for README-only or full docs generation
By Rejith Krishnan1 min read
repo-readme-generator: README and Docs Skill for Codex

What it is

repo-readme-generator creates or updates project documentation from files it has actually read, including README-only and full suite modes with AGENTS.md. The skill is strict about evidence: if a fact cannot be verified, it should be marked as TBD instead of guessed. This helps teams avoid polished but inaccurate documentation.

Install and usage

Codex CLI prerequisite: PowerShell setup or WSL setup.

Install, then restart Codex:

$skill-installer install https://github.com/lowtouch-ai/krithi-skills/tree/main/skills/repo-readme-generator

Usage examples from the repository README:

$repo-readme-generator create the README for this repo
$repo-readme-generator document this repo fully

For update and uninstall steps, see the krithi-skills README.

About the Author

Rejith Krishnan

Rejith Krishnan

Founder and CEO

Rejith Krishnan is the Founder and CEO of lowtouch.ai, a platform dedicated to empowering enterprises with private, no-code AI agents. With expertise in Site Reliability Engineering (SRE), Kubernetes, and AI systems architecture, he is passionate about simplifying the adoption of AI-driven automation to transform business operations.

Rejith specializes in deploying Large Language Models (LLMs) and building intelligent agents that automate workflows, enhance customer experiences, and optimize IT processes, all while ensuring data privacy and security. His mission is to help businesses unlock the full potential of enterprise AI with seamless, scalable, and secure solutions that fit their unique needs.

LinkedIn →