summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-04-22 09:07:47 +0300
committerPaul Buetow <paul@buetow.org>2026-04-22 09:07:47 +0300
commit519be7e7dd12cbe3c85f90cf06d65b377eb22a3c (patch)
tree59bc012999bd03a26e5fa6c097741ede7b211296 /README.md
parent24dd98eaa9759884b17f18c729d498af6ec70e9e (diff)
add logo
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/README.md b/README.md
index 4f65385..b823ba0 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# ComicForge
-![ComicForge logo](assets/comicforge-logo.png)
+![ComicForge](assets/comicforge.png)
ComicForge turns a vocabulary file into a generated comic package. It uses Gemini-backed providers to write a story, draw comic pages, and optionally produce narration. The CLI writes comic assets into `./comics/assets/<slug>/`, gallery copies into `./comics/gallery/`, and final PDFs into `./comics/PDF/`.
@@ -54,6 +54,8 @@ Environment variables also work. `COMICFORGE_` is the prefix, and dots in config
- `COMICFORGE_MODELS_IMAGE`
- `COMICFORGE_COMIC_STORY_PAGES`
+If `COMICFORGE_API_GOOGLE_API_KEY` is not set, ComicForge falls back to `GOOGLE_API_KEY`.
+
Start from [`config.yaml.example`](config.yaml.example). The important settings are:
```yaml
@@ -97,7 +99,7 @@ narration:
prompts_dir: ./prompts
```
-`provider.*` currently supports Gemini in this codebase. Set `api.google_api_key` or `COMICFORGE_API_GOOGLE_API_KEY` for Gemini-backed generation.
+`provider.*` currently supports Gemini in this codebase. Set `api.google_api_key`, `COMICFORGE_API_GOOGLE_API_KEY`, or fallback `GOOGLE_API_KEY` for Gemini-backed generation.
## Usage