diff --git a/README.md b/README.md index 8f5a019..4fe03a9 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,54 @@ -# 部署指南 +# Arboris | AI 写作伙伴,点亮你的创作灵感 -## 准备环境 +你是否曾面对空白的文档,灵感枯竭?是否曾被宏大的故事设定、错综复杂的人物关系搞得焦头烂额? + +**Arboris** 为每一位小说家而生。它不仅仅是一个写作工具,更是你的专属 AI 创意伙伴,致力于将你从繁琐的构思与整理工作中解放出来,让你专注于创作本身——那个最激动人心的部分。 + +**在线体验:** [https://arboris.aozhiai.com](https://arboris.aozhiai.com) + +--- +image +image +image +image +image +image +image + +--- + +## ✨ Arboris 能为你做什么? + +想象一下,你只需提出一个模糊的想法,AI 就能为你…… + +- **🌱 孕育世界**: 从零开始构建一个全新的世界观,包括独特的派系、关键的地点和丰富的背景设定。 +- **🎭 塑造角色**: 创造有血有肉的角色,并用一张清晰的关系网将他们联系起来,让人物关系一目了然。 +- **🗺️ 规划蓝图**: 将灵感火花扩展成完整的故事大纲,从开端、发展到高潮,情节脉络清晰可见。 +- **✍️ 挥洒文墨**: 在你的指导下,AI 可以撰写完整的章节草稿。它会提供多个版本供你挑选、修改,如同与一位不知疲倦的写手并肩作战。 + +### 核心亮点 + +- **交互式写作台**: 一个沉浸式的创作空间,你可以在这里与 AI 对话、下达指令、编辑和优化生成的文本。 +- **版本与评估**: AI 生成的每个草稿都会被妥善保存。你可以对比不同版本,标记出满意的部分,教会 AI 更懂你的风格。 +- **项目式管理**: 将每部小说作为一个独立项目进行管理,所有设定、大纲、章节都井井有条,告别混乱。 +- **高度可定制**: 从驱动 AI 的核心提示词(Prompt)到模型的 API 设置,一切尽在你的掌控之中。你可以通过后台轻松调整,让 Arboris 更符合你的创作习惯。 +- **一键部署**: 我们提供完整的 Docker 配置,只需一条命令,即可在你自己的服务器上拥有一个专属的 AI 写作助手。 + + +## 🚀 立即开始 + +拥有自己的 Arboris 过程非常简单。 + +### 准备环境 - 复制环境变量模板:`cp .env.example .env` - 根据部署环境调整 `.env` 内的数据库、SMTP、OpenAI 及开关配置。 -## 使用官方镜像 +### 使用官方镜像 - 已推送镜像:`tichui251/arboris-app:latest` - 推荐执行 `docker pull tichui251/arboris-app:latest` 获取最新版本。 - 镜像标签已在 `docker-compose.yml` 中配置,如需固定版本可自行修改。 -## 使用 Docker Compose 启动 +### 使用 Docker Compose 启动 1. 确认 `.env` 与 `docker-compose.yml` 位于同一目录。 2. 若需要内置 MySQL,执行(推荐内置): ```bash @@ -20,7 +59,7 @@ docker compose up -d ``` -## 环境变量摘要 +### 环境变量摘要 | 变量 | 必填 | 说明 | | --- | --- | --- | | `APP_PORT` | 否 | 映射到宿主机的 HTTP 端口,默认 `80`。 | @@ -55,3 +94,4 @@ | `LINUXDO_USER_INFO_URL` | 否 | 用户信息查询地址,默认官方地址。 | > 其余可选参数与示例说明详见 `.env.example` 注释。 +