lywsvip/StreamCap
1
0
Fork 0
mirror of https://github.com/ihmily/StreamCap.git synced 2026-05-06 21:51:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update readme

Browse Source
This commit is contained in:
ihmily
2025-04-12 16:09:07 +08:00
parent 9714b24cd7
commit b2864ea897
2 changed files with 14 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -57,6 +57,9 @@ cd StreamCap
2.**安装依赖**：
```bash
# 安装核心依赖
pip install -i https://pypi.org/simple streamget
# 桌面端
pip install -r requirements.txt
@@ -80,17 +83,15 @@ cp .env.example .env
python main.py
```
修改 `.env` 文件，将 `PLATFORM` 的值改为 `web`，即可以Web方式运行。
Linux请使用web方式运行，修改 `.env` 文件，将 `PLATFORM` 的值改为 `web`，即可以Web方式运行。
或者，无需修改配置文件，直接使用以下命令启动
或者无需修改配置文件，直接使用以下命令启动
```bash
# Linux请使用web方式运行
python main.py --web
```
启动成功后，通过 `http://ip:6006` 访问。
启动成功后，通过 `http://127.0.0.1:6006` 访问。更多配置请参考 [Web运行指南](https://github.com/ihmily/StreamCap/wiki/安装指南#web-端运行)
如果程序提示缺少 FFmpeg，请访问 FFmpeg 官方下载页面[Download FFmpeg](https://ffmpeg.org/download.html)，下载预编译的 FFmpeg 可执行文件，并配置环境变量。
@@ -100,7 +101,7 @@ python main.py --web
1.**快速启动**
最简单方法是运行项目中的 [docker-compose.yml](https://github.com/ihmily/StreamCap/blob/main/docker-compose.yml) 文件，进入项目根目录后，只需简单执行以下命令(确保已经存在`.env`文件)：
最简单方法是使用`docker compose`运行，进入项目根目录后，只需简单执行以下命令(确保已经存在`.env`文件)：
```bash
docker compose up

13
README_EN.md
View File

@@ -56,6 +56,9 @@ cd StreamCap
2.**Install Dependencies**:
```bash
# Install core dependencies
pip install -i https://pypi.org/simple streamget
# For desktop
pip install -r requirements.txt
@@ -79,17 +82,15 @@ On Windows and macOS, the program runs as a desktop application by default. Use
python main.py
```
To run the program in web mode, modify the `.env` file and change the value of PLATFORM to web.
On Linux, please run in web mode. Modify the `.env` file and change the value of `PLATFORM` to `web` to run in web mode.
Alternatively, you can run the program in web mode without modifying the configuration file by using the following command:
Alternatively, you can start it without modifying the configuration file by using the following command:
```bash
# On Linux, please run in web mode
python main.py --web
```
After successful startup, access it via `http://ip:6006`.
After successful startup, access it via `http://127.0.0.1:6006`.For more configuration details, refer to the [Web Operation Guide](https://github.com/ihmily/StreamCap/wiki/Installation-Guide#web-operation)
If the program prompts that FFmpeg is missing, please visit the FFmpeg official download page [Download FFmpeg](https://ffmpeg.org/download.html) to download the precompiled FFmpeg executable files and configure the environment variables.
@@ -99,7 +100,7 @@ No Python environment is required on your local machine. Before running the comm
1.**Quick Start**
The simplest method is to run the [docker-compose.yml](https://github.com/ihmily/StreamCap/blob/main/docker-compose.yml) file in the project. Navigate to the project root directory and execute the following command (ensure the `.env` file exists):
The simplest method is to use `docker compose`. Navigate to the project root directory and execute the following command (ensure the `.env` file exists):
```bash
docker compose up