Skip to content

Commit 4878545

Browse files
committed
📝 更新README
1 parent ed983eb commit 4878545

File tree

1 file changed

+27
-20
lines changed

1 file changed

+27
-20
lines changed

readme.md

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,48 @@
11
# SimpleCutPy
2+
23
***一款简单的影视素材剪辑器,用于对游戏回放素材进行快速剪辑***
34

5+
> [!WARNING]
6+
>
7+
> SimpleCutPy 仍在进行开发中,除去对输入数据的校验功能,基本功能应已可用。
8+
>
9+
> 您可能在使用中会遇到大量的 bug,欢迎提交 issue。
10+
411
---
512

613
## 什么是 SimpleCutPy
14+
715
SimpleCutPy 是一款简单的影视素材剪辑器,它可以对素材(建议是尺寸相似的)进行简单剪辑,
816
例如调整顺序,截取其中某一个片段。
917

1018
制作它的灵感和需求来源于对游戏即时回放片段的拼接,通过它您可以轻松的对各种即时回放片段进行拼接和简单处理。
1119

1220
它的工作原理很简单:将界面上设置的参数转化为使用 ffmpeg 进行处理的命令行,然后自动调用ffmpeg对素材进行处理。
1321

14-
## 我该如何获取 SimpleCutPy
15-
获取 SimpleCutPy,可以在 release 页面中找到打包可供 windows 平台使用的可执行程序文件。
22+
## SimpleCutPy 的工作原理
1623

17-
对于其他平台,很不幸的是,您可能需要下载项目源代码进行一些修改——因为我在命令行生成的部分以 windows 平台为目标实现了。
18-
关于命令行生成的部分,您可以在 (SimpleCutMainFrame.py) SimpleCutMainFrame.ExportBtnOnClick() 的实现中找到。
24+
SimpleCutPy 使用 wxPython 构建 UI 界面,并通过 UI 界面生成 ffmpeg 命令行并进行执行。
1925

20-
---
26+
## 我该如何使用 SimpleCutPy
2127

22-
## 如何使用项目源代码
23-
项目源代码由四个文件组成:
28+
为了使用 SimpleCutPy 你需要先安装 ffmpeg。您可以在系统终端中输入 `ffmpeg` 查看是否已经安装了ffmpeg。
29+
30+
为获取 SimpleCutPy,可以在 release 页面中找到打包可供 windows 平台使用的可执行程序文件。
31+
32+
对于其他平台,我没有测试过兼容性,但是由于实现方式的特性,您可以试试能否使用。
33+
34+
---
2435

25-
- main.py
26-
- SimpleCutPy.py
27-
- SimpleCutMainFrame.py
28-
- PureClipFBP.fbp
36+
## 使用 Pyinstaller 打包 SimpleCutPy
2937

30-
我会在下面一个接一个地介绍这些文件的作用。
31-
### main.py
32-
这是整个程序的入口文件,如果想要直接在python中运行整个程序,请直接运行这个文件
38+
在项目根目录使用如下命令
39+
`pyinstaller main.spec`
3340

34-
### SimpleCutPy.py
35-
这是由 wxFormBuilder 生成的文件,主要对程序界面和控件进行了布局并绑定了相关的回调函数。
41+
打包生成的文件会在 `./dist/SimpleCutPy.exe`
3642

37-
### SimpleCutMainFrame.py
38-
这是程序主要逻辑实现的地方。
43+
下面是对一些文件的介绍:
3944

40-
### PureClipFBP.fbp
41-
这是 wxFormBuilder 的工程文件,使用 wxFormBuilder 打开这个工程文件,您可以看到这个程序的界面设计。
45+
- `main.py`:这是整个程序的入口文件,如果想要直接在python中运行整个程序,请直接运行这个文件
46+
- `SimpleCutPy.py`:这是由 wxFormBuilder 生成的文件,主要对程序界面和控件进行了布局并绑定了相关的回调函数。
47+
- `SimpleCutMainFrame.py`:这是程序主要逻辑实现的地方。
48+
- `SimpleCutPy.fbp`: 这是 wxFormBuilder 的工程文件,使用 wxFormBuilder 打开这个工程文件,您可以看到这个程序的界面设计。

0 commit comments

Comments
 (0)