Skip to content

Commit d284e45

Browse files
committed
feat: add bilingual docs and split README by language
1 parent 954333b commit d284e45

5 files changed

Lines changed: 164 additions & 19 deletions

File tree

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
<img src="assets/icon.png" alt="Breast TNM Tool icon" width="128" height="128" />
33
<h1>Breast TNM Tool</h1>
44
<p><strong>Desktop app for breast cancer TNM staging, molecular subtype stratification, and treatment planning.</strong></p>
5-
<p>乳腺癌 TNM + 分子分型桌面工具</p>
5+
<p>
6+
<a href="README.zh-CN.md">简体中文</a> | <strong>English</strong>
7+
</p>
68

79
<p>
810
<a href="https://github.com/liqi3333/breast/releases/latest"><img alt="Latest Release" src="https://img.shields.io/github/v/release/liqi3333/breast?display_name=tag&label=release" /></a>
@@ -14,7 +16,7 @@
1416
<p>
1517
<a href="https://github.com/liqi3333/breast/releases/latest"><img alt="Download Latest EXE" src="https://img.shields.io/badge/Download-Latest%20EXE-e91e63?style=for-the-badge" /></a>
1618
<a href="https://github.com/liqi3333/breast/releases"><img alt="View Releases" src="https://img.shields.io/badge/View-Releases-6f42c1?style=for-the-badge" /></a>
17-
<a href="https://github.com/liqi3333/breast"><img alt="Source Code" src="https://img.shields.io/badge/View-Source-24292f?style=for-the-badge" /></a>
19+
<a href="https://github.com/liqi3333/breast"><img alt="View Source" src="https://img.shields.io/badge/View-Source-24292f?style=for-the-badge" /></a>
1820
</p>
1921
</div>
2022

@@ -47,7 +49,7 @@ Breast TNM Tool is an Electron desktop application that packages a single-file H
4749
Open the latest release page and download the packaged Windows executable:
4850

4951
- Latest release: <https://github.com/liqi3333/breast/releases/latest>
50-
- Direct release list: <https://github.com/liqi3333/breast/releases>
52+
- All releases: <https://github.com/liqi3333/breast/releases>
5153

5254
### Run locally
5355

@@ -66,26 +68,26 @@ npm run build:win
6668
Build output:
6769

6870
```text
69-
dist/Breast-TNM-Tool-1.0.1.exe
71+
dist/Breast-TNM-Tool-1.0.2.exe
7072
```
7173

7274
## Release Automation
7375

7476
This repository includes GitHub Actions workflows for build and release automation.
7577

7678
- Push to `main`: runs Windows build validation and uploads workflow artifacts
77-
- Push a tag like `v1.0.1`: automatically builds the Windows x64 portable EXE, creates a GitHub Release, and uploads `dist/*.exe`
79+
- Push a tag like `v1.0.2`: automatically builds the Windows x64 portable EXE, creates a GitHub Release, and uploads `dist/*.exe`
7880

7981
Example:
8082

8183
```bash
82-
git tag v1.0.1
83-
git push origin v1.0.1
84+
git tag v1.0.2
85+
git push origin v1.0.2
8486
```
8587

8688
## Release Notes Template
8789

88-
Chinese release notes template:
90+
The bilingual release notes template is located at:
8991

9092
```text
9193
docs/RELEASE_TEMPLATE.md
@@ -108,6 +110,8 @@ The release workflow uses this file as the main body of the release notes, then
108110
├── index.html
109111
├── main.js
110112
├── package.json
113+
├── README.md
114+
├── README.zh-CN.md
111115
└── .github/workflows/
112116
├── build-windows.yml
113117
└── release.yml

README.zh-CN.md

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
<div align="center">
2+
<img src="assets/icon.png" alt="Breast TNM Tool 图标" width="128" height="128" />
3+
<h1>Breast TNM Tool</h1>
4+
<p><strong>乳腺癌 TNM 分期、分子分型与治疗计划桌面工具</strong></p>
5+
<p>
6+
<strong>简体中文</strong> | <a href="README.md">English</a>
7+
</p>
8+
9+
<p>
10+
<a href="https://github.com/liqi3333/breast/releases/latest"><img alt="最新版本" src="https://img.shields.io/github/v/release/liqi3333/breast?display_name=tag&label=release" /></a>
11+
<a href="https://github.com/liqi3333/breast/releases"><img alt="下载次数" src="https://img.shields.io/github/downloads/liqi3333/breast/total?label=downloads" /></a>
12+
<a href="https://github.com/liqi3333/breast/actions/workflows/build-windows.yml"><img alt="Windows 构建" src="https://github.com/liqi3333/breast/actions/workflows/build-windows.yml/badge.svg" /></a>
13+
<a href="https://github.com/liqi3333/breast/actions/workflows/release.yml"><img alt="Release 发布" src="https://github.com/liqi3333/breast/actions/workflows/release.yml/badge.svg" /></a>
14+
</p>
15+
16+
<p>
17+
<a href="https://github.com/liqi3333/breast/releases/latest"><img alt="下载最新 EXE" src="https://img.shields.io/badge/下载-最新%20EXE-e91e63?style=for-the-badge" /></a>
18+
<a href="https://github.com/liqi3333/breast/releases"><img alt="查看 Releases" src="https://img.shields.io/badge/查看-Releases-6f42c1?style=for-the-badge" /></a>
19+
<a href="https://github.com/liqi3333/breast"><img alt="查看源码" src="https://img.shields.io/badge/查看-源码-24292f?style=for-the-badge" /></a>
20+
</p>
21+
</div>
22+
23+
## 项目简介
24+
25+
Breast TNM Tool 是一个基于 Electron 的桌面应用,把单文件 HTML 临床界面封装成 Windows 可执行程序。它可以在同一个界面中查看乳腺癌 TNM 分期、分子分型、简化预后分期,以及个体化治疗和随访建议。
26+
27+
## 核心功能
28+
29+
- 集成 TNM 分期与分子分型选择
30+
- 展示解剖学分期与简化预后分期
31+
- 提供治疗计划与随访建议面板
32+
- 可构建为 Windows 便携版 EXE
33+
- 支持 GitHub Actions 自动构建与自动发布
34+
35+
## 界面截图
36+
37+
### 主界面
38+
39+
![Breast TNM Tool overview](assets/screenshots/overview.png)
40+
41+
### 治疗计划面板
42+
43+
![Breast TNM Tool treatment plan](assets/screenshots/treatment-plan.png)
44+
45+
## 快速开始
46+
47+
### 下载使用
48+
49+
打开最新 Release 页面,下载打包好的 Windows 可执行程序:
50+
51+
- 最新版本:<https://github.com/liqi3333/breast/releases/latest>
52+
- 全部 Releases:<https://github.com/liqi3333/breast/releases>
53+
54+
### 本地运行
55+
56+
```bash
57+
npm install
58+
npm start
59+
```
60+
61+
### 构建 Windows 便携版 EXE
62+
63+
```bash
64+
npm install
65+
npm run build:win
66+
```
67+
68+
构建产物:
69+
70+
```text
71+
dist/Breast-TNM-Tool-1.0.2.exe
72+
```
73+
74+
## 自动发布流程
75+
76+
仓库已内置 GitHub Actions 自动构建与发布流程。
77+
78+
- 推送到 `main`:自动执行 Windows 构建检查,并上传 workflow artifact
79+
- 推送形如 `v1.0.2` 的标签:自动构建 Windows x64 便携版 EXE、创建 GitHub Release,并上传 `dist/*.exe`
80+
81+
示例:
82+
83+
```bash
84+
git tag v1.0.2
85+
git push origin v1.0.2
86+
```
87+
88+
## Release 说明模板
89+
90+
双语发布说明模板位于:
91+
92+
```text
93+
docs/RELEASE_TEMPLATE.md
94+
```
95+
96+
Release 工作流会把这个文件作为发布说明正文,再自动附加 GitHub 生成的更新说明。
97+
98+
## 项目结构
99+
100+
```text
101+
.
102+
├── assets/
103+
│ ├── icon.ico
104+
│ ├── icon.png
105+
│ └── screenshots/
106+
├── docs/
107+
│ └── RELEASE_TEMPLATE.md
108+
├── scripts/
109+
│ └── capture-screenshots.js
110+
├── index.html
111+
├── main.js
112+
├── package.json
113+
├── README.md
114+
├── README.zh-CN.md
115+
└── .github/workflows/
116+
├── build-windows.yml
117+
└── release.yml
118+
```
119+
120+
## 注意事项
121+
122+
- 仓库默认不提交 `node_modules/``dist/`
123+
- Windows 首次运行时,可能因为 EXE 未签名而出现 SmartScreen 提示
124+
- 医学内容仅供信息参考,不替代正式诊断、病理判断或临床决策

docs/RELEASE_TEMPLATE.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,43 @@
1-
# Breast TNM Tool 更新日志
1+
# Breast TNM Tool Release Notes | 更新日志
2+
3+
This release provides a Windows x64 portable EXE that can be downloaded and run directly.
24

35
本版本提供 Windows x64 便携版 EXE,可下载后直接双击运行。
46

5-
## 本版亮点
7+
## Highlights | 本版亮点
8+
9+
- Preserves the full Breast TNM Tool desktop interface
10+
- Supports anatomic staging and simplified prognostic staging display
11+
- Includes treatment planning and follow-up recommendation panel
12+
- Provides downloadable Windows EXE assets directly from the Release page
613

7-
- 完整保留乳腺癌 TNM + 分子分型桌面工具界面
14+
- 完整保留 Breast TNM Tool 桌面应用界面
815
- 支持解剖学分期与简化预后分期展示
9-
- 支持个体化治疗计划与随访建议查看
16+
- 提供治疗计划与随访建议面板
1017
- Release 页面直接提供可下载的 Windows EXE 附件
1118

12-
## 下载与使用
19+
## Download and Usage | 下载与使用
20+
21+
1. Download `Breast-TNM-Tool-*.exe` from the assets on this page
22+
2. Run it on Windows by double-clicking the file
23+
3. If SmartScreen appears on first launch, click "More info" and then "Run anyway"
1324

1425
1. 下载本页附件中的 `Breast-TNM-Tool-*.exe`
1526
2. 在 Windows 系统中双击运行
1627
3. 若首次运行出现 SmartScreen 提示,点击“更多信息”后选择“仍要运行”
1728

18-
## 版本说明
29+
## Version Notes | 版本说明
30+
31+
- This version is built and published automatically by GitHub Actions
32+
- The EXE includes Windows metadata such as product name, version, company name, and file description
1933

2034
- 此版本由 GitHub Actions 自动构建并发布
2135
- EXE 已写入产品名称、版本号、公司名与文件描述等 Windows 元信息
2236

23-
## 注意事项
37+
## Notes | 注意事项
38+
39+
- The EXE is currently not code signed
40+
- Medical content is for informational use only and does not replace diagnosis, pathology review, or formal clinical decision-making
2441

2542
- 当前 EXE 未进行代码签名
2643
- 本项目内容仅供医学信息参考,不替代临床诊断、病理判断或正式治疗决策

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "breast-tnm-tool",
3-
"version": "1.0.1",
4-
"description": "Desktop breast cancer TNM and molecular subtype staging tool",
3+
"version": "1.0.2",
4+
"description": "Desktop app for breast cancer TNM staging and molecular subtype stratification | 乳腺癌 TNM 分期与分子分型桌面工具",
55
"main": "main.js",
66
"author": {
77
"name": "shbsrh"

0 commit comments

Comments
 (0)