Metadata-Version: 2.1
Name: codex-readme
Version: 0.1.0
Summary: This tool generates readmes using Codex
Home-page: https://github.com/tom-doerr/codex-readme
Author: Tom Dörr
Author-email: tom.doerr@tum.de
License: MIT
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE

<h1 align="center">🤖 codex-readme 📜</h1>
<p align="center">
    <img src='https://github.com/tom-doerr/bins/raw/main/codex-readme/r5.gif'>
    <p align="center">
        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/). 
    </p>
</p>


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



