diff --git a/docs/docs/100-tools/03-offerings/02-image-generation.md b/docs/docs/100-tools/03-offerings/02-image-generation.md index c637fb5f..d0e80db1 100644 --- a/docs/docs/100-tools/03-offerings/02-image-generation.md +++ b/docs/docs/100-tools/03-offerings/02-image-generation.md @@ -14,13 +14,16 @@ referencing the tool's link in your GPTScript. For now, you can follow the steps git clone https://github.com/gptscript-ai/image-generation ``` -2. Run `make bootstrap` to setup the python venv and install the required dependencies. +2. In the newly cloned repo, run `make bootstrap` to setup the python venv and install the required dependencies. Then activate the virtual environment. ```shell make bootstrap +source .venv/bin/activate ``` -3. Reference `/tool.gpt` in your GPTScript. +> Note: You can install the python dependencies manually by running `pip install -r requirements.txt` in the root of the cloned repository. This prevents the need to run `make bootstrap` or activate the virtual environment. + +3. In the same shell session that your virutal environment is activated, reference `/tool.gpt` in your GPTScript. ## Usage To use the Image Generation tool, you need to make sure that the OPENAI_API_KEY environment variable is set to your OpenAI API key. You can obtain an API key from the OpenAI platform if you don't already have one. diff --git a/examples/story-book/README.md b/examples/story-book/README.md index a30f4e68..0ebd5cc6 100644 --- a/examples/story-book/README.md +++ b/examples/story-book/README.md @@ -17,9 +17,11 @@ by `index.html` which has some JS/CSS to make the story styling consistent and r cd image-generation make bootstrap source .venv/bin/activate - cd - # returns you back to your original directory + cd ../gptscript # returns you back to your original directory ``` + > Note: You can install the python dependencies manually by running `pip install -r requirements.txt` in the root of the cloned repository. This prevents the need to run `make bootstrap` or activate the virtual environment. + 2. **Run the `story-book.gpt` script.** In the same terminal session where the virtual environment (venv) is now activated, navigate to the `story-book` example directory and run the `story-book.gpt` script: