← all repositories

tom-doerr/codex-readme

A Python tool that uses OpenAI Codex to automatically generate README.md documentation for code projects.

401 stars Python Coding Assistants
codex-readme
Not currently ranked — collecting fresh signals.
star history

This project reads source code files and concatenates their beginnings into a prompt that is sent to OpenAI Codex, an AI model specialized in code-related tasks. Codex then generates appropriate README documentation based on the code structure and content. Users run a single Python script to invoke the automated documentation generation.

Frequently asked

What is tom-doerr/codex-readme?
A Python tool that uses OpenAI Codex to automatically generate README.md documentation for code projects.
Is codex-readme open source?
Yes — tom-doerr/codex-readme is open source, released under the MIT license.
What language is codex-readme written in?
tom-doerr/codex-readme is primarily written in Python.
How popular is codex-readme?
tom-doerr/codex-readme has 401 stars on GitHub.
Where can I find codex-readme?
tom-doerr/codex-readme is on GitHub at https://github.com/tom-doerr/codex-readme.

heatdrop uses Google Analytics to see which pages get read — nothing else. Your call. How we handle data.