docs: Add OPENAI_API_KEY instruction to readme

alexandrainst · Apr 19, 2024 · a56c1fa · a56c1fa
1 parent 115c0a0
commit a56c1fa
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -21,7 +21,8 @@ Developer(s):
 1. Run `make install`, which sets up a virtual environment and all Python dependencies
    therein.
 2. Run `source .venv/bin/activate` to activate the virtual environment.
-3. Run `python src/scripts/create_dataset.py` to create the dataset.
+3. Run `echo "OPENAI_API_KEY=<your-openai-api-key> > .env` to enable OpenAI generation.
+4. Run `python src/scripts/create_dataset.py` to create the dataset.
 
 The raw dataset will be stored in `data/raw` and will be updated continuously during
 creation, and the final dataset will appear in your `data/final`.