Skip to content

Commit e6912cf

Browse files
authored
docs: clarify details about installing the image-generation tool (#116)
Signed-off-by: tylerslaton <[email protected]>
1 parent 9b50fe1 commit e6912cf

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

docs/docs/100-tools/03-offerings/02-image-generation.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,16 @@ referencing the tool's link in your GPTScript. For now, you can follow the steps
1414
git clone https://github.com/gptscript-ai/image-generation
1515
```
1616

17-
2. Run `make bootstrap` to setup the python venv and install the required dependencies.
17+
2. In the newly cloned repo, run `make bootstrap` to setup the python venv and install the required dependencies. Then activate the virtual environment.
1818

1919
```shell
2020
make bootstrap
21+
source .venv/bin/activate
2122
```
2223

23-
3. Reference `<path-to-the-repo>/tool.gpt` in your GPTScript.
24+
> 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.
25+
26+
3. In the same shell session that your virutal environment is activated, reference `<path-to-the-repo>/tool.gpt` in your GPTScript.
2427

2528
## Usage
2629
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.

examples/story-book/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,11 @@ by `index.html` which has some JS/CSS to make the story styling consistent and r
1717
cd image-generation
1818
make bootstrap
1919
source .venv/bin/activate
20-
cd - # returns you back to your original directory
20+
cd ../gptscript # returns you back to your original directory
2121
```
2222

23+
> 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.
24+
2325
2. **Run the `story-book.gpt` script.**
2426

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

0 commit comments

Comments
 (0)