11<div align =" center " >
22 <img src =" assets/icon.png " alt =" Breast TNM Tool icon " width =" 128 " height =" 128 " />
33 <h1 >Breast TNM Tool</h1 >
4+ <p ><strong >Desktop app for breast cancer TNM staging, molecular subtype stratification, and treatment planning.</strong ></p >
45 <p >乳腺癌 TNM + 分子分型桌面工具</p >
6+
7+ <p >
8+ <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>
9+ <a href="https://github.com/liqi3333/breast/releases"><img alt="Downloads" src="https://img.shields.io/github/downloads/liqi3333/breast/total?label=downloads" /></a>
10+ <a href="https://github.com/liqi3333/breast/actions/workflows/build-windows.yml"><img alt="Build Windows EXE" src="https://github.com/liqi3333/breast/actions/workflows/build-windows.yml/badge.svg" /></a>
11+ <a href="https://github.com/liqi3333/breast/actions/workflows/release.yml"><img alt="Release Windows EXE" src="https://github.com/liqi3333/breast/actions/workflows/release.yml/badge.svg" /></a>
12+ </p >
13+
14+ <p >
15+ <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>
16+ <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>
18+ </p >
519</div >
620
7- 这是一个基于 Electron 的桌面应用,用单文件 HTML 页面封装为 Windows 可执行程序,提供乳腺癌 TNM 分期、分子分型、简化预后分期,以及个体化治疗计划与随访建议的可视化界面。
21+ ## Overview
22+
23+ Breast TNM Tool is an Electron desktop application that packages a single-file HTML clinical interface into a Windows executable. It helps users review breast cancer TNM stage, molecular subtype, simplified prognostic staging, and individualized treatment follow-up suggestions in one screen.
824
9- ## 功能
25+ ## Highlights
1026
11- - 乳腺癌 TNM 分期选择
12- - 分子分型与组织学分级整合
13- - 解剖学分期与简化预后分期展示
14- - 个体化治疗计划与随访建议面板
15- - 一键构建 Windows 便携版 EXE
16- - GitHub Actions 自动构建与 Release 发布
27+ - Integrated TNM staging and molecular subtype selection
28+ - Simplified anatomic stage and prognostic stage display
29+ - Treatment planning and follow-up recommendation panel
30+ - Windows portable EXE build output
31+ - Automated GitHub Actions build and release pipeline
1732
18- ## 项目截图
33+ ## Screenshots
1934
20- ### 主界面
35+ ### Main interface
2136
2237![ Breast TNM Tool overview] ( assets/screenshots/overview.png )
2338
24- ### 治疗计划面板
39+ ### Treatment plan panel
2540
2641![ Breast TNM Tool treatment plan] ( assets/screenshots/treatment-plan.png )
2742
28- ## 本地开发
43+ ## Quick Start
44+
45+ ### Download
46+
47+ Open the latest release page and download the packaged Windows executable:
48+
49+ - Latest release: < https://github.com/liqi3333/breast/releases/latest >
50+ - Direct release list: < https://github.com/liqi3333/breast/releases >
51+
52+ ### Run locally
2953
3054``` bash
3155npm install
3256npm start
3357```
3458
35- ## 构建 Windows 便携版 EXE
59+ ### Build Windows portable EXE
3660
3761``` bash
3862npm install
3963npm run build:win
4064```
4165
42- 构建完成后,产物默认位于:
66+ Build output:
4367
4468``` text
4569dist/Breast-TNM-Tool-1.0.1.exe
4670```
4771
48- ## 自动 Release 流程
72+ ## Release Automation
4973
50- 仓库内已包含 GitHub Actions Release 工作流。
74+ This repository includes GitHub Actions workflows for build and release automation.
5175
52- - 推送到 ` main ` 时,会自动执行 Windows 构建检查并上传 artifact
53- - 推送形如 ` v1.0.0 ` 的 tag 时,会自动:
54- - 构建 Windows x64 便携版 EXE
55- - 创建 GitHub Release
56- - 把 ` dist/*.exe ` 作为 Release 附件上传
76+ - 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 `
5778
58- 示例:
79+ Example:
5980
6081``` bash
6182git tag v1.0.1
6283git push origin v1.0.1
6384```
6485
65- ## 发布说明
86+ ## Release Notes Template
6687
67- 发布说明模板位于:
88+ Chinese release notes template:
6889
6990``` text
7091docs/RELEASE_TEMPLATE.md
7192```
7293
73- 你可以按需修改模板内容,Release 工作流会自动把它作为中文发布说明正文的一部分,同时附加 GitHub 自动生成的更新说明。
94+ The release workflow uses this file as the main body of the release notes, then appends GitHub-generated notes automatically.
7495
75- ## 项目结构
96+ ## Project Structure
7697
7798``` text
7899.
@@ -92,8 +113,8 @@ docs/RELEASE_TEMPLATE.md
92113 └── release.yml
93114```
94115
95- ## 说明
116+ ## Notes
96117
97- - 当前仓库默认不提交 ` node_modules/ ` 与 ` dist/ `
98- - Windows 第一次运行未签名 EXE 时,可能会看到 SmartScreen 提示
99- - 医学分期与治疗建议仅供医学信息参考,不替代临床诊断与正式治疗决策
118+ - ` node_modules/ ` and ` dist/ ` are not committed
119+ - On first launch, Windows SmartScreen may show a warning because the EXE is not code signed
120+ - Medical content is for informational use only and does not replace formal diagnosis or clinical decision-making
0 commit comments