https://github.com/tom-doerr/codex-readme

Revolutionize your project documentation with the Codex-README generator, utilizing OpenAI's Codex for intelligent README creation.
https://github.com/tom-doerr/codex-readme

ai codex openai readme readme-generator

Last synced: about 11 hours ago
JSON representation

Revolutionize your project documentation with the Codex-README generator, utilizing OpenAI's Codex for intelligent README creation.

• Host: GitHub
• URL: https://github.com/tom-doerr/codex-readme
• Owner: tom-doerr
• License: mit
• Created: 2021-09-24T01:11:08.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-08-10T17:06:09.000Z (over 1 year ago)
• Last Synced: 2025-01-18T11:09:18.845Z (8 days ago)
• Topics: ai, codex, openai, readme, readme-generator
• Language: Python
• Homepage:
• Size: 31.3 KB
• Stars: 404
• Watchers: 12
• Forks: 21
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-codex - Codex Readme - Readme generator
• project-awesome - tom-doerr/codex-readme - Revolutionize your project documentation with the Codex-README generator, utilizing OpenAI's Codex for intelligent README creation. (Python)
• jimsghstars - tom-doerr/codex-readme - Revolutionize your project documentation with the Codex-README generator, utilizing OpenAI's Codex for intelligent README creation. (Python)

README

        
🤖 codex-readme 📜



    

    


        The gif shows how the readme below was generated. To generate your own readmes you need to get access to the Codex API (https://openai.com/blog/openai-codex/). 

    


# codex-readme

## What is it?

This project is a set of programs that I use to create a README.md file.

## How does it work?

It reads program files and concatenates the beginning of all files to create a input prompt which is then fed to OpenAI Codex to generate a README.

## How to use it?

```

./codex_readme.py

```

## TODO

- [ ] Add more programs and improve the README.md generator.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Credits

This project is based on the OpenAI Codex project.

## Contact

If you have any questions or would like to get in touch, please open an issue on Github or send me an email: 

-------------------------------------------------------------------

[Traffic Statistics](https://tom-doerr.github.io/github_repo_stats_data/tom-doerr/codex-readme/latest-report/report.html)