diff --git a/README.md b/README.md index 6214f02..1c709f6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,39 @@ [![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint) [![Buymeacoffee](https://badgen.net/badge/icon/buymeacoffee?icon=buymeacoffee&label)](https://www.buymeacoffee.com/mrbeverage) -In progress. +# OpenAI Language Quiz Generator + +## Contents + +## Why + +## Getting started + +Right now it is a simple Python app, installable from the command line via [Poetry](https://python-poetry.org/): +``` + python -m pip install --upgrade pip + pip install poetry + poetry install +``` +This app will additiionally require a postgresql database, and an OpenAI API key in your environment. (This will be configurable, and hidden later.) +``` + # It is probably better to put this into a dotfile: + export $OPENAI_API_KEY=... +``` +A postgresql database is then required, however this is already configured in a docker-compose.yml: +``` + # From the root directory of the repo: + docker-compose up +``` +Better secrets management for both the OpenAI keys and database passwords will be coming shortly when the effort to cloud host this as an API will be undertaken. + +Once running, you will need to pre-populate the database with a minimal verb set before any sentence or problem generation. To do that, run the following: +``` + dbtest database init +``` +From there the application is ready to start generating problem data from the command line. See the documentation below. + +## Usage + +## Examples + +## Roadmap