Skip to content

Commit aac485f

Browse files
committed
Modify the main program startup and front-end usage instructions
1 parent 8f59749 commit aac485f

File tree

2 files changed

+22
-6
lines changed

2 files changed

+22
-6
lines changed

README-zh-tw.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@
119119

120120
## 操作說明
121121

122-
在運行應用程式之前,請先準備串流設定檔 `config/configuration.json`(格式示例如下),以及完成「啟動方式」與「環境變數」的設定
122+
在運行應用程式之前,請先完成「啟動方式」與「環境變數」的設定。串流設定檔 `config/configuration.json` 為選用,且一般不建議手動編輯;預設「資料庫模式」會集中管理串流。若您有進階需求再使用檔案式多串流設定,示例如下
123123

124124
```json
125125
[
@@ -256,6 +256,8 @@
256256

257257
8. **啟動主程式(兩種模式)**
258258

259+
兩種模式擇一使用,請勿同時執行「資料庫模式」與「JSON 模式」。
260+
259261
* **資料庫模式(預設)**
260262
`main.py` 會每隔固定秒數輪詢資料庫的 `stream_configs`,並動態啟動/重啟/停止各串流的子行程。
261263

@@ -265,8 +267,8 @@
265267
python main.py --poll 5
266268
```
267269

268-
* **JSON 模式(以檔案配置多串流)**
269-
使用 `--config` 指定 JSON 檔路徑;主程式會為 JSON 陣列中的每個串流配置各自啟動一個子行程。
270+
* **JSON 模式(以檔案配置多串流)— 選用、進階,不建議一般使用者**
271+
使用 `--config` 指定 JSON 檔路徑;主程式會為 JSON 陣列中的每個串流配置各自啟動一個子行程。此模式與「資料庫模式」互斥,請擇一啟用
270272

271273
```bash
272274
python main.py --config config/configuration.json
@@ -281,6 +283,12 @@
281283

282284
> 使用前,請先開啟「網頁設定」並設定各 API 端點(如:DETECT_API_URL、STREAMING_API_URL、DB_MANAGEMENT_API_URL、FCM_API_URL)以符合你的環境,然後再進行登入與操作。
283285
286+
### iOS App
287+
288+
- App Store: https://apps.apple.com/tw/app/visionnaire/id6743549024
289+
290+
備註:若需完整的通知功能,請與我們聯繫。
291+
284292

285293
## 資料庫設定與管理
286294

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ Below are examples of real-time hazard detection by the system:
129129

130130
## Quick Start (Recommended)
131131

132-
Before running the application, prepare your stream configuration file `config/configuration.json` (see below for an example), and complete the following quick start and environment variable setup steps.
132+
Before running the application, complete the following quick start and environment variable setup steps. Preparing a JSON stream configuration file `config/configuration.json` is optional and generally not recommended; the default Database Mode centrally manages streams. If you need file-based multi-stream config for advanced use cases, see the optional example below.
133133

134134
```json
135135
[
@@ -266,6 +266,8 @@ Before running the application, prepare your stream configuration file `config/c
266266

267267
8. **Start the Main Program (Two Modes)**
268268

269+
Choose one mode only; do not run Database Mode and JSON Mode at the same time.
270+
269271
* **Database Mode (Default)**
270272
`main.py` will poll the `stream_configs` table and dynamically start/restart/stop stream subprocesses.
271273

@@ -275,8 +277,8 @@ Before running the application, prepare your stream configuration file `config/c
275277
python main.py --poll 5
276278
```
277279

278-
* **JSON Mode (File-based Multi-stream Config)**
279-
Use `--config` to specify the JSON file path; the main program will start a subprocess for each stream config in the array.
280+
* **JSON Mode (File-based Multi-stream Config) — Optional, advanced; not recommended for most users**
281+
Use `--config` to specify the JSON file path; the main program will start a subprocess for each stream config in the array. This mode is mutually exclusive with Database Mode.
280282

281283
```bash
282284
python main.py --config config/configuration.json
@@ -291,6 +293,12 @@ Before running the application, prepare your stream configuration file `config/c
291293

292294
> Before using, please open the Web Settings and configure API endpoints first (e.g., DETECT_API_URL, STREAMING_API_URL, DB_MANAGEMENT_API_URL, FCM_API_URL) to match your environment; then proceed with login and operations.
293295
296+
### iOS App
297+
298+
- App Store: https://apps.apple.com/tw/app/visionnaire/id6743549024
299+
300+
Note: For complete notification functionality, please contact us.
301+
294302

295303
## Database Configuration and Management
296304

0 commit comments

Comments
 (0)