docs: update readme for env

This commit is contained in:
p
2026-01-17 18:57:15 +08:00
parent de6fe4b294
commit 59ab8f8935
2 changed files with 18 additions and 22 deletions
+9 -11
View File
@@ -78,13 +78,6 @@ source .venv/bin/activate
pip install -r requirements.txt pip install -r requirements.txt
``` ```
Create `.env` file and fill in API Key:
```ini
# backend/.env
GOOGLE_API_KEY="your_google_api_key_here"
```
Initialize the database using Alembic: Initialize the database using Alembic:
```bash ```bash
@@ -136,22 +129,27 @@ Access in browser: `http://localhost:5173`
## 📖 User Guide ## 📖 User Guide
1. **Create Project**: Click "New Project" on the homepage and enter the comic title and introduction. 1. **Configure Models**:
2. **Story & Configuration**: * Click "Models" in the top navigation bar.
* Add a new configuration with your Google API Key.
* Ensure the model type is set correctly (Text/Image) and activated.
2. **Create Project**: Click "New Project" on the homepage and enter the comic title and introduction.
3. **Story & Configuration**:
* Enter your story outline. * Enter your story outline.
* Set global styles (e.g., "Japanese Shonen"), aspect ratio, etc. * Set global styles (e.g., "Japanese Shonen"), aspect ratio, etc.
* Click "Generate Storyboard Config", and AI will generate the character list and storyboard script. * Click "Generate Storyboard Config", and AI will generate the character list and storyboard script.
![Story & Configuration](assets/story_config.png) ![Story & Configuration](assets/story_config.png)
3. **Character Workshop**: 4. **Character Workshop**:
* View AI-generated character settings. * View AI-generated character settings.
* Click "Draw" to generate character portraits. * Click "Draw" to generate character portraits.
* If there are duplicate characters, use the "Merge Characters" function to clean them up. * If there are duplicate characters, use the "Merge Characters" function to clean them up.
![Character Workshop](assets/character_studio.png) ![Character Workshop](assets/character_studio.png)
4. **Storyboard Editing**: 5. **Storyboard Editing**:
* Check the description of each panel in the storyboard list. * Check the description of each panel in the storyboard list.
* Click "Generate Image" or "Generate All" to start drawing the comic. * Click "Generate Image" or "Generate All" to start drawing the comic.
* Click on an image to view it in large size and support downloading. * Click on an image to view it in large size and support downloading.
+9 -11
View File
@@ -77,13 +77,6 @@ source .venv/bin/activate
pip install -r requirements.txt pip install -r requirements.txt
``` ```
创建 `.env` 文件并填入 API Key
```ini
# backend/.env
GOOGLE_API_KEY="your_google_api_key_here"
```
使用 Alembic 初始化数据库: 使用 Alembic 初始化数据库:
```bash ```bash
@@ -135,22 +128,27 @@ pnpm dev
## 📖 使用指南 ## 📖 使用指南
1. **创建项目**: 在首页点击“新建项目”,输入漫画标题和简介。 1. **配置模型**:
2. **故事与配置**: * 在顶部导航栏点击 "Models"。
* 添加新的配置并填入你的 Google API Key。
* 确保模型类型设置正确(Text/Image)并已启用。
2. **创建项目**: 在首页点击“新建项目”,输入漫画标题和简介。
3. **故事与配置**:
* 输入你的故事大纲。 * 输入你的故事大纲。
* 设置全局风格(如“日系少年漫”)、画幅比例等。 * 设置全局风格(如“日系少年漫”)、画幅比例等。
* 点击“生成分镜配置”,AI 将生成角色表和分镜脚本。 * 点击“生成分镜配置”,AI 将生成角色表和分镜脚本。
![故事与配置](assets/story_config.png) ![故事与配置](assets/story_config.png)
3. **角色工坊**: 4. **角色工坊**:
* 查看 AI 生成的角色设定。 * 查看 AI 生成的角色设定。
* 点击“绘制”生成角色立绘。 * 点击“绘制”生成角色立绘。
* 如有重复角色,使用“合并角色”功能进行清理。 * 如有重复角色,使用“合并角色”功能进行清理。
![角色工坊](assets/character_studio.png) ![角色工坊](assets/character_studio.png)
4. **分镜编辑**: 5. **分镜编辑**:
* 在分镜列表中检查每一格的描述。 * 在分镜列表中检查每一格的描述。
* 点击“生成图片”或“一键生成所有”开始绘制漫画。 * 点击“生成图片”或“一键生成所有”开始绘制漫画。
* 点击图片可查看大图,支持下载。 * 点击图片可查看大图,支持下载。