semvec/pypi-packages huggingface dataset:
vivarium-convenience 0.0.3
provides a vivarium process with a configurable convenience kinetics
License: MIT

# Template Vivarium Project

Visit [the Vivarium Core
documentation](https://vivarium-core.readthedocs.io/) to learn how to
use the core Vivarium engine to create computational biology models.
Check out the
[getting started](https://vivarium-core.readthedocs.io/en/latest/getting_started.html)
guide of the documentation. 

## Using this Template
This repository contains a skeleton project you can build on to create
your own models. Go to the 
[github page](https://github.com/vivarium-collective/vivarium-template) 
and select `use this template`.

What follows is a template `README.md`.

<!--
TODO: Rename the `vivarium_convenience` folder to something that makes sense for
your project.
-->

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

# Project Name

<!--
TODO: Fill in your own project name
-->

Introduction to your project.

<!--
TODO: Fill in your own introduction.
-->

## Installation

Explain how users can get up and running.

<!--
TODO: Fill in your own installation instructions. This might be as
simple as:

```
pip install <your package name>
```
-->
codex-readme 0.1.0
This tool generates readmes using Codex
License: MIT

<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>