Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
btfranklin committed Aug 30, 2024
1 parent 764bbf5 commit e3fdbb3
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The title of the story will be generated by the LLM as a final step of the proce

The tool produces output in the form of a series of images and their associated narratives. By default, these are saved in a directory named `output` in the current working directory, with each file named according to the step number. For example, the first image in the story will be saved as `output/0.png`, and the first narrative will be saved as `output/0.txt`.

Additionally, the tool generates a title for the story, saved as `output/title.txt`, and a compiled PDF document containing the entire story, including all images and narratives, saved as `output/story.pdf`.
Additionally, the tool generates a title for the story, saved as `output/title.txt`, and a compiled PDF document containing the entire story, including all images and narratives, saved as `output/story.pdf`. The PDF will also include the contents of a file named `concept.txt` on the first page, which contains the story's concept.

## Configuration Parameters

Expand All @@ -36,16 +36,22 @@ Please note that the only required parameter is the `story-concept` parameter.

## Usage

To execute the tool, simply run the following command:
The entry point for the Spooklight tool from the command line is `cli.py`. To execute the tool, simply run the following command:

```bash
python main.py --story-concept "An unlikely rebellion of oppressed people fighting against a tyrannical council of wizards"
python cli.py --story-concept "An unlikely rebellion of oppressed people fighting against a tyrannical council of wizards"
```

This will generate a story with a single image and narrative, based on the provided story concept. If you'd like to specify a starting image or limit the story length, include the appropriate parameters:

```bash
python main.py --starting-image-path "path/to/image.png" --story-concept "An epic journey through uncharted lands" --story-length 10
python cli.py --starting-image-path "path/to/image.png" --story-concept "An epic journey through uncharted lands" --story-length 10
```

If you wish to start the story from a description rather than an image, you can use the `--starting-image-description` parameter like this:

```bash
python cli.py --starting-image-description "A misty forest at dawn with a mysterious figure in the distance" --story-concept "A lone wanderer discovers an ancient secret in the forest"
```

## License
Expand Down

0 comments on commit e3fdbb3

Please sign in to comment.