Skip to content

tom-doerr/codex-readme

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 

🤖 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 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: tom.doerr@tum.de


Traffic Statistics

About

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

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages