Skip to content

Commit 0e398a0

Browse files
authored
Merge pull request #62 from linyqh/dev
docs: 测试 release 2
2 parents 35d7736 + db4d2a0 commit 0e398a0

File tree

1 file changed

+3
-128
lines changed

1 file changed

+3
-128
lines changed

README.md

Lines changed: 3 additions & 128 deletions
Original file line numberDiff line numberDiff line change
@@ -48,138 +48,13 @@ NarratoAI 是一个自动化影视解说工具,基于LLM实现文案撰写、
4848
- 建议最低 CPU 4核或以上,内存 8G 或以上,显卡非必须
4949
- Windows 10 或 MacOS 11.0 以上系统
5050

51-
## 快速开始 🚀
52-
### 1. 申请 Google AI studio 账号
53-
1. 访问 https://aistudio.google.com/app/prompts/new_chat 申请账号
54-
2. 点击 `Get API Key` 申请 API Key
55-
3. 申请的 API Key 填入 `config.example.toml` 文件中的 `gemini_api_key` 配置
56-
57-
### 2. 配置 proxy VPN
58-
> 配置vpn的方法不限,只要能正常访问 Google 网络即可,本文采用的是 chash
59-
1. 记住 clash 服务的端口,一般为 `http://127.0.0.1:7890`
60-
2. 若端口不为 `7890`,请修改 `docker-compose.yml` 文件中的 `VPN_PROXY_URL` 为你的代理地址
61-
```yaml
62-
environment:
63-
- "VPN_PROXY_URL=http://host.docker.internal:7890" # 修改为你的代理端口;host.docker.internal表示物理机的IP
64-
```
65-
3. (可选)或者修改 `config.example.toml` 文件中的 `proxy` 配置
66-
```toml
67-
[proxy]
68-
http = "http://xx.xx.xx.xx:7890"
69-
https = "http://xx.xx.xx.xx:7890"
70-
```
71-
72-
### 3. 使用【整合包】开始 📥 (适用与 Windows 用户)
73-
**NarratoAI 整合包 v0.1.2 发布啦** 🎉🎉🎉
74-
75-
关注微信公众号【NarratoAI助手】,回复关键词【整合包】即可获取最新下载链接!快来试试吧!
76-
77-
注意事项:
78-
- 当前仅提供 Windows 版本,Mac和Linux用户请使用 docker 启动。
79-
80-
81-
### 4. 使用【docker】开始🐳 (适用与 Mac 和 Linux 用户)
82-
#### ① 拉取项目,启动Docker
83-
```shell
84-
git clone https://github.com/linyqh/NarratoAI.git
85-
cd NarratoAI
86-
docker-compose up
87-
```
88-
#### ② 访问Web界面
89-
90-
打开浏览器,访问 http://127.0.0.1:8501
91-
92-
#### ③ 访问API文档
93-
94-
打开浏览器,访问 http://127.0.0.1:8080/docs 或者 http://127.0.0.1:8080/redoc
95-
96-
## 使用方法 🛠️
97-
#### 1. 基础配置,选择模型,填入APIKey,选择模型
98-
> 目前暂时只支持 `Gemini` 模型,其他模式待后续更新,欢迎大家提交 [PR](https://github.com/linyqh/NarratoAI/pulls),参与开发 🎉🎉🎉
99-
<div align="center">
100-
<img src="docs/img001-zh.png" alt="001" width="1000"/>
101-
</div>
102-
103-
#### 2. 选择需要解说的视频,点击生成视频脚本
104-
> 平台内置了一个演示视频,若要使用自己的视频,将mp4文件放在 `resource/videos` 目录下,刷新浏览器即可,
105-
> 注意:文件名随意,但文件名不能包含中文,特殊字符,空格,反斜杠等
106-
<div align="center">
107-
<img src="docs/img002-zh.png" alt="002" width="400"/>
108-
</div>
109-
110-
#### 3. 保存脚本,开始剪辑
111-
> 保存脚本后,刷新浏览器,在脚本文件的下拉框就会有新生成的 `.json` 脚本文件,选择json文件和视频就可以开始剪辑了。
112-
<div align="center">
113-
<img src="docs/img003-zh.png" alt="003" width="400"/>
114-
</div>
115-
116-
#### 4. 检查视频,若视频存在不符合规则的片段,可以点击重新生成或者手动编辑
117-
<div align="center">
118-
<img src="docs/img004-zh.png" alt="003" width="1000"/>
119-
</div>
120-
121-
#### 5. 配置视频基本参数
122-
<div align="center">
123-
<img src="docs/img005-zh.png" alt="003" width="700"/>
124-
</div>
125-
126-
#### 6. 开始生成
127-
<div align="center">
128-
<img src="docs/img006-zh.png" alt="003" width="1000"/>
129-
</div>
130-
131-
#### 7. 视频生成完成
132-
<div align="center">
133-
<img src="docs/img007-zh.png" alt="003" width="1000"/>
134-
</div>
135-
136-
## 开发 💻
137-
1. 安装依赖
138-
```shell
139-
conda create -n narratoai python=3.11
140-
conda activate narratoai
141-
cd narratoai
142-
pip install -r requirements.txt
143-
```
144-
145-
2. 安装 ImageMagick
146-
###### Windows:
147-
148-
- 下载 https://imagemagick.org/archive/binaries/ImageMagick-7.1.1-38-Q16-x64-static.exe
149-
- 安装下载好的 ImageMagick,注意不要修改安装路径
150-
- 修改 `配置文件 config.toml` 中的 `imagemagick_path` 为你的实际安装路径(一般在 `C:\Program Files\ImageMagick-7.1.1-Q16\magick.exe`)
151-
152-
###### MacOS:
153-
154-
```shell
155-
brew install imagemagick
156-
````
157-
158-
###### Ubuntu
159-
160-
```shell
161-
sudo apt-get install imagemagick
162-
```
163-
164-
###### CentOS
165-
166-
```shell
167-
sudo yum install ImageMagick
168-
```
169-
3. 启动 webui
170-
```shell
171-
streamlit run ./webui/Main.py --browser.serverAddress=127.0.0.1 --server.enableCORS=True --browser.gatherUsageStats=False
172-
```
173-
4. 访问 http://127.0.0.1:8501
174-
175-
17651
## 反馈建议 📢
17752

178-
### 👏 1. 可以提交 [issue](https://github.com/linyqh/NarratoAI/issues)或者 [pull request](https://github.com/linyqh/NarratoAI/pulls)
53+
👏 1. 可以提交 [issue](https://github.com/linyqh/NarratoAI/issues)或者 [pull request](https://github.com/linyqh/NarratoAI/pulls)
17954

180-
### 💬 2. [加入开源社区交流群](https://github.com/linyqh/NarratoAI/wiki)
55+
💬 2. [加入开源社区交流群](https://github.com/linyqh/NarratoAI/wiki)
18156

182-
### 👉 3. [常见问题](https://thread-marsupial-df8.notion.site/105866888dab80988650fa063b1df4eb)
57+
📷 3. 关注公众号【NarratoAI助手】,掌握最新资讯
18358

18459
## 参考项目 📚
18560
- https://github.com/FujiwaraChoki/MoneyPrinter

0 commit comments

Comments
 (0)