Skip to content

Commit bafcd39

Browse files
committed
docs: update readme and deployment notes
1 parent 6523d54 commit bafcd39

4 files changed

Lines changed: 100 additions & 44 deletions

File tree

DEPLOYMENT.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,8 @@ Notes:
9494

9595
This is the most practical default. The repo already includes Redis, the Manim runtime, and the Node runtime in the deployment path.
9696

97+
If you have already published the image, you can also deploy from `wingflow/manimcat` instead of rebuilding locally each time.
98+
9799
### 1. Prepare environment variables
98100

99101
```bash
@@ -123,6 +125,12 @@ docker compose build
123125
docker compose up -d
124126
```
125127

128+
If you want to use the published image directly, replace the `build` section in `docker-compose.yml` with:
129+
130+
```yaml
131+
image: wingflow/manimcat
132+
```
133+
126134
### 3. Verify
127135
128136
```bash
@@ -170,6 +178,8 @@ The repository `Dockerfile` is already the Hugging Face compatible one:
170178

171179
Do not follow older instructions that mention `Dockerfile.huggingface`. That file is not part of the current repo.
172180

181+
If you have already published a Docker image, other environments can reference `wingflow/manimcat`; however, Hugging Face Spaces still builds from the repository `Dockerfile` rather than running a Docker Hub image directly.
182+
173183
### 2. Configure Space Settings
174184

175185
Minimum variables:

DEPLOYMENT.zh-CN.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,8 @@ npm start
9494

9595
这是最推荐的部署方式,仓库已经内置 Redis、Manim 运行时和 Node 运行时。
9696

97+
如果你已经将镜像推到了 Docker Hub,也可以直接使用 `wingflow/manimcat`,不必每次都本地 `build`
98+
9799
### 1. 准备环境变量
98100

99101
```bash
@@ -123,6 +125,12 @@ docker compose build
123125
docker compose up -d
124126
```
125127

128+
如果改为直接使用已发布镜像,请把 `docker-compose.yml` 里的 `build` 段替换为:
129+
130+
```yaml
131+
image: wingflow/manimcat
132+
```
133+
126134
### 3. 验证
127135
128136
```bash
@@ -170,6 +178,8 @@ docker volume inspect manimcat_studio-workspace-data
170178

171179
不需要再额外复制一个 `Dockerfile.huggingface`,仓库里也没有这个文件。
172180

181+
如果你已经发布了 Docker 镜像,也可以让其他部署环境直接参考 `wingflow/manimcat` 的内容;但 Hugging Face Space 仍然是基于仓库内 `Dockerfile` 构建,不是直接拉 Docker Hub 镜像运行。
182+
173183
### 2. 在 Space Settings 配置变量
174184

175185
至少配置:

README.md

Lines changed: 40 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -71,28 +71,44 @@ English | [简体中文](https://github.com/Wing900/ManimCat/blob/main/README.zh
7171

7272
I am happy to introduce my new project, ManimCat. It is, after all, a cat.
7373

74-
Built on top of [manim-video-generator](https://github.com/rohitg00/manim-video-generator), ManimCat is now a much broader AI-assisted creation system for math teaching visuals rather than just a single generation flow.
75-
76-
It is designed for classroom explanation, worked-example breakdowns, and visual reasoning tasks. You can use natural language to generate, modify, rerender, and organize Manim-based teaching content with both `video` and `image` outputs.
77-
78-
The project currently has two distinct modes: `Workflow Mode` for direct generation and rendering, and `Agent Mode` for Studio-based collaborative work with longer-lived sessions, review, and iteration.
79-
80-
### Interface
81-
82-
<div align="center">
83-
<img src="https://github.com/user-attachments/assets/5abd29f6-adcb-4047-b85c-aba1fa0808a5" width="49%" alt="ManimCat desktop UI screenshot 1" />
84-
<img src="https://github.com/user-attachments/assets/d18d0f27-15b4-4c59-8a4b-a8b8fb553020" width="49%" alt="ManimCat desktop UI screenshot 2" />
85-
</div>
86-
87-
<div align="center">
88-
<img src="https://github.com/user-attachments/assets/2c70886f-c381-4995-8ca4-2d0db1974829" width="49%" alt="ManimCat desktop UI screenshot 3" />
89-
<img src="https://github.com/user-attachments/assets/ce3718e8-4bc4-44db-87fb-3fb486eed144" width="49%" alt="ManimCat desktop UI screenshot 4" />
90-
</div>
74+
Built on top of [manim-video-generator](https://github.com/rohitg00/manim-video-generator), ManimCat is now a much broader AI-assisted creation system for math teaching visuals rather than just a single generation flow.
75+
76+
It is designed for classroom explanation, worked-example breakdowns, and visual reasoning tasks. You can use natural language to generate, modify, rerender, and organize Manim-based teaching content with both `video` and `image` outputs.
77+
78+
The project currently has two distinct modes: `Workflow Mode` for direct generation and rendering, and `Agent Mode` for Studio-based collaborative work with longer-lived sessions, review, and iteration.
79+
80+
- `Workflow Mode` currently supports two direct output paths: `video` and `image`
81+
- `Agent Mode` currently includes two studios: `Plot Studio` (about 60% complete) and `Manim Studio` (about 20% complete)
82+
- `Plot Studio` is for matplotlib-based static math visuals, charts, and teaching figures
83+
- `Manim Studio` is for Manim animation workflows, but it is still at an early stage
9184

92-
<div align="center">
93-
<img src="https://github.com/user-attachments/assets/b831caaf-10fe-4238-8998-d574f42af524" width="49%" alt="ManimCat desktop UI screenshot 5" />
94-
<img src="https://github.com/user-attachments/assets/30583571-f038-4c7b-9362-c988a896d374" width="49%" alt="ManimCat desktop UI screenshot 6" />
95-
</div>
85+
### Interface
86+
87+
#### UI
88+
89+
<div align="center">
90+
<img src="https://github.com/user-attachments/assets/5abd29f6-adcb-4047-b85c-aba1fa0808a5" width="40%" alt="ManimCat UI screenshot 1" />
91+
<img src="https://github.com/user-attachments/assets/d18d0f27-15b4-4c59-8a4b-a8b8fb553020" width="40%" alt="ManimCat UI screenshot 2" />
92+
</div>
93+
94+
<div align="center">
95+
<img src="https://github.com/user-attachments/assets/2c70886f-c381-4995-8ca4-2d0db1974829" width="40%" alt="ManimCat UI screenshot 3" />
96+
<img src="https://github.com/user-attachments/assets/ce3718e8-4bc4-44db-87fb-3fb486eed144" width="40%" alt="ManimCat UI screenshot 4" />
97+
</div>
98+
99+
#### Workflow
100+
101+
<div align="center">
102+
<img src="https://github.com/user-attachments/assets/b831caaf-10fe-4238-8998-d574f42af524" width="46%" alt="ManimCat Workflow screenshot 1" />
103+
<img src="https://github.com/user-attachments/assets/30583571-f038-4c7b-9362-c988a896d374" width="46%" alt="ManimCat Workflow screenshot 2" />
104+
</div>
105+
106+
#### Plot Studio
107+
108+
<div align="center">
109+
<img src="https://github.com/user-attachments/assets/0812b601-b896-4137-8e20-a2d4b6feadb9" width="46%" alt="ManimCat Plot Studio screenshot 1" />
110+
<img src="https://github.com/user-attachments/assets/99ae423f-4b15-431d-8e21-30a6b6171616" width="46%" alt="ManimCat Plot Studio screenshot 2" />
111+
</div>
96112

97113
## Examples
98114

@@ -120,7 +136,9 @@ cd ..
120136
npm run dev
121137
```
122138

123-
Open `http://localhost:3000`. For environment variables and deployment-specific setup, see the [deployment guide](https://github.com/Wing900/ManimCat/blob/main/DEPLOYMENT.md).
139+
Open `http://localhost:3000`. For environment variables and deployment-specific setup, see the [deployment guide](https://github.com/Wing900/ManimCat/blob/main/DEPLOYMENT.md).
140+
141+
If you want a direct Docker deployment path, you can also start from the published image `wingflow/manimcat` instead of building locally first.
124142

125143

126144
## Technology

README.zh-CN.md

Lines changed: 40 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -71,28 +71,44 @@
7171

7272
很荣幸在这里介绍我的新项目ManimCat,它是~一只猫~
7373

74-
本项目基于 [manim-video-generator](https://github.com/rohitg00/manim-video-generator) 进行了大幅重构与再开发,现在已经不只是单一生成流程,而是一个更完整的 AI 数学教学可视化创作系统。
75-
76-
它面向课堂讲解、例题拆解与数形结合表达等场景,用户可以通过自然语言生成、修改、重渲染并组织基于 Manim 的教学内容,支持 `video``image` 两种输出。
77-
78-
项目目前包含两种明确区分的模式:`Workflow Mode` 用于直接生成与渲染,`Agent Mode` 用于基于 Studio 的协作式创作、审阅与迭代。
79-
80-
### 界面
81-
82-
<div align="center">
83-
<img src="https://github.com/user-attachments/assets/5abd29f6-adcb-4047-b85c-aba1fa0808a5" width="49%" alt="ManimCat 桌面界面截图 1" />
84-
<img src="https://github.com/user-attachments/assets/d18d0f27-15b4-4c59-8a4b-a8b8fb553020" width="49%" alt="ManimCat 桌面界面截图 2" />
85-
</div>
86-
87-
<div align="center">
88-
<img src="https://github.com/user-attachments/assets/2c70886f-c381-4995-8ca4-2d0db1974829" width="49%" alt="ManimCat 桌面界面截图 3" />
89-
<img src="https://github.com/user-attachments/assets/ce3718e8-4bc4-44db-87fb-3fb486eed144" width="49%" alt="ManimCat 桌面界面截图 4" />
90-
</div>
74+
本项目基于 [manim-video-generator](https://github.com/rohitg00/manim-video-generator) 进行了大幅重构与再开发,现在已经不只是单一生成流程,而是一个更完整的 AI 数学教学可视化创作系统。
75+
76+
它面向课堂讲解、例题拆解与数形结合表达等场景,用户可以通过自然语言生成、修改、重渲染并组织基于 Manim 的教学内容,支持 `video``image` 两种输出。
77+
78+
项目目前包含两种明确区分的模式:`Workflow Mode` 用于直接生成与渲染,`Agent Mode` 用于基于 Studio 的协作式创作、审阅与迭代。
79+
80+
- `Workflow Mode` 当前支持两类直接产出:`video``image`
81+
- `Agent Mode` 当前包含两个 Studio:`Plot Studio`(开发程度约 60%)与 `Manim Studio`(开发程度约 20%)
82+
- `Plot Studio` 面向 matplotlib 静态数学图像、函数图与教学插图
83+
- `Manim Studio` 面向 Manim 动画工作流,但目前仍处于明显早期阶段
9184

92-
<div align="center">
93-
<img src="https://github.com/user-attachments/assets/b831caaf-10fe-4238-8998-d574f42af524" width="49%" alt="ManimCat 桌面界面截图 5" />
94-
<img src="https://github.com/user-attachments/assets/30583571-f038-4c7b-9362-c988a896d374" width="49%" alt="ManimCat 桌面界面截图 6" />
95-
</div>
85+
### 界面
86+
87+
#### UI 界面
88+
89+
<div align="center">
90+
<img src="https://github.com/user-attachments/assets/5abd29f6-adcb-4047-b85c-aba1fa0808a5" width="40%" alt="ManimCat UI 界面截图 1" />
91+
<img src="https://github.com/user-attachments/assets/d18d0f27-15b4-4c59-8a4b-a8b8fb553020" width="40%" alt="ManimCat UI 界面截图 2" />
92+
</div>
93+
94+
<div align="center">
95+
<img src="https://github.com/user-attachments/assets/2c70886f-c381-4995-8ca4-2d0db1974829" width="40%" alt="ManimCat UI 界面截图 3" />
96+
<img src="https://github.com/user-attachments/assets/ce3718e8-4bc4-44db-87fb-3fb486eed144" width="40%" alt="ManimCat UI 界面截图 4" />
97+
</div>
98+
99+
#### Workflow 界面
100+
101+
<div align="center">
102+
<img src="https://github.com/user-attachments/assets/b831caaf-10fe-4238-8998-d574f42af524" width="46%" alt="ManimCat Workflow 界面截图 1" />
103+
<img src="https://github.com/user-attachments/assets/30583571-f038-4c7b-9362-c988a896d374" width="46%" alt="ManimCat Workflow 界面截图 2" />
104+
</div>
105+
106+
#### Plot Studio 界面
107+
108+
<div align="center">
109+
<img src="https://github.com/user-attachments/assets/0812b601-b896-4137-8e20-a2d4b6feadb9" width="46%" alt="ManimCat Plot Studio 界面截图 1" />
110+
<img src="https://github.com/user-attachments/assets/99ae423f-4b15-431d-8e21-30a6b6171616" width="46%" alt="ManimCat Plot Studio 界面截图 2" />
111+
</div>
96112

97113
## 样例
98114

@@ -120,7 +136,9 @@ cd ..
120136
npm run dev
121137
```
122138

123-
访问 `http://localhost:3000`。环境变量、部署方式以及上游路由示例请查看[部署文档](https://github.com/Wing900/ManimCat/blob/main/DEPLOYMENT.zh-CN.md)
139+
访问 `http://localhost:3000`。环境变量、部署方式以及上游路由示例请查看[部署文档](https://github.com/Wing900/ManimCat/blob/main/DEPLOYMENT.zh-CN.md)
140+
141+
如果你直接用 Docker 镜像部署,也可以从 `wingflow/manimcat` 开始,而不是自行本地构建。
124142

125143

126144
## 技术

0 commit comments

Comments
 (0)