Skip to content

Commit a42cf1a

Browse files
committed
docs: polish product-style README
1 parent 40716d3 commit a42cf1a

2 files changed

Lines changed: 182 additions & 30 deletions

File tree

‎README.md‎

Lines changed: 90 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,128 @@
11
<div align="center">
22
<h1>Thyroid TNM Tool</h1>
3-
<p><strong>Standalone PC and mobile web app for thyroid cancer TNM staging and treatment planning.</strong></p>
3+
<p><strong>Product-style PC and mobile web app for thyroid cancer TNM staging, treatment planning, and follow-up reference.</strong></p>
44
<p><a href="README.zh-CN.md">简体中文</a> | <strong>English</strong></p>
5+
56
<p>
67
<a href="https://github.com/liqi3333/thyroid/releases/latest"><img alt="Latest Release" src="https://img.shields.io/github/v/release/liqi3333/thyroid?display_name=tag&label=release" /></a>
8+
<a href="https://github.com/liqi3333/thyroid/releases"><img alt="Downloads" src="https://img.shields.io/github/downloads/liqi3333/thyroid/total?label=downloads" /></a>
79
<a href="https://github.com/liqi3333/thyroid/actions/workflows/build-html.yml"><img alt="Build HTML" src="https://github.com/liqi3333/thyroid/actions/workflows/build-html.yml/badge.svg" /></a>
810
<a href="https://github.com/liqi3333/thyroid/actions/workflows/release.yml"><img alt="Release HTML" src="https://github.com/liqi3333/thyroid/actions/workflows/release.yml/badge.svg" /></a>
911
</p>
12+
1013
<p>
11-
<a href="https://liqi3333.github.io/thyroid/"><img alt="Open Online" src="https://img.shields.io/badge/Open-Online%20Page-0ea5e9?style=for-the-badge" /></a>
14+
<a href="https://liqi3333.github.io/thyroid/"><img alt="Open PC Web" src="https://img.shields.io/badge/Open-PC%20Web-0ea5e9?style=for-the-badge" /></a>
1215
<a href="https://liqi3333.github.io/thyroid/mobile.html"><img alt="Open Mobile Web" src="https://img.shields.io/badge/Open-Mobile%20Web-f59e0b?style=for-the-badge" /></a>
13-
<a href="https://github.com/liqi3333/thyroid/releases/latest"><img alt="Download HTML" src="https://img.shields.io/badge/Download-Latest%20HTML-10b981?style=for-the-badge" /></a>
16+
<a href="https://github.com/liqi3333/thyroid/releases/latest"><img alt="Download Latest HTML" src="https://img.shields.io/badge/Download-Latest%20HTML-10b981?style=for-the-badge" /></a>
1417
</p>
1518
</div>
1619

1720
## Overview
1821

19-
This project packages both a standalone desktop HTML page and a separate mobile-optimized HTML page for thyroid cancer TNM staging, treatment planning, and follow-up suggestions into a shareable GitHub repository with release automation and GitHub Pages deployment.
22+
Thyroid TNM Tool packages a single-file clinical HTML interface into a deliverable product with a public GitHub repository, standalone HTML downloads, GitHub Pages deployment, and automated releases.
23+
24+
It now provides two separate web entry points:
25+
26+
- **PC web version**: preserves the original desktop-style layout
27+
- **Mobile web version**: a separate `mobile.html` optimized for phone browsers
28+
29+
## Why this project is useful
30+
31+
- Fast AJCC 8th edition thyroid cancer staging lookup
32+
- Treatment planning and follow-up suggestions in the same screen
33+
- No backend, no installation required for web usage
34+
- Can be opened online or downloaded as a standalone HTML file
35+
- Keeps PC and mobile experiences separate instead of forcing one responsive compromise
2036

2137
## Access
2238

2339
- GitHub repository: <https://github.com/liqi3333/thyroid>
24-
- Online PC page: <https://liqi3333.github.io/thyroid/>
25-
- Online mobile page: <https://liqi3333.github.io/thyroid/mobile.html>
40+
- PC web page: <https://liqi3333.github.io/thyroid/>
41+
- Mobile web page: <https://liqi3333.github.io/thyroid/mobile.html>
2642
- Latest release: <https://github.com/liqi3333/thyroid/releases/latest>
43+
- All releases: <https://github.com/liqi3333/thyroid/releases>
44+
45+
## Delivery formats
46+
47+
The repository currently ships these forms:
48+
49+
- `index.html`, original PC web version
50+
- `mobile.html`, separate phone-optimized version
51+
- Release asset: `Thyroid-TNM-Tool-1.0.1.html`
52+
- Release asset: `Thyroid-TNM-Tool-mobile-1.0.1.html`
53+
54+
## Quick Start
55+
56+
### Use online
57+
58+
- Open the PC page: <https://liqi3333.github.io/thyroid/>
59+
- Open the mobile page: <https://liqi3333.github.io/thyroid/mobile.html>
60+
61+
### Download standalone HTML
2762

28-
## Local usage
63+
Download the latest files from:
2964

30-
Open `index.html` directly in a browser, or generate the release-ready HTML file:
65+
- <https://github.com/liqi3333/thyroid/releases/latest>
66+
67+
Then open either HTML file directly in a browser.
68+
69+
### Build locally
3170

3271
```bash
3372
npm run build:html
3473
```
3574

36-
Output:
75+
Build outputs:
3776

3877
```text
3978
dist-html/Thyroid-TNM-Tool-1.0.1.html
4079
dist-html/Thyroid-TNM-Tool-mobile-1.0.1.html
4180
```
4281

43-
## Automation
82+
## Product highlights
83+
84+
- Thyroid cancer TNM staging interface
85+
- Treatment plan and follow-up recommendation panel
86+
- Standalone offline-friendly HTML distribution
87+
- Separate PC and mobile web entry points
88+
- Public GitHub Pages deployment
89+
- Automated GitHub Actions build and release workflow
90+
- Bilingual project documentation
91+
92+
## Release automation
93+
94+
This repository includes GitHub Actions workflows for delivery automation.
95+
96+
- Push to `main`: build validation and upload HTML artifacts
97+
- Push a tag such as `v1.0.1`: generate desktop and mobile standalone HTML files, then publish them to GitHub Releases
98+
- GitHub Pages serves both `index.html` and `mobile.html`
99+
100+
Example:
44101

45-
- Push to `main`: run HTML build and upload desktop + mobile workflow artifacts
46-
- Push a tag like `v1.0.1`: build both desktop/mobile HTML files and publish them to GitHub Releases
47-
- GitHub Pages serves `index.html` and `mobile.html`
102+
```bash
103+
git tag v1.0.1
104+
git push origin v1.0.1
105+
```
106+
107+
## Project structure
108+
109+
```text
110+
.
111+
├── docs/
112+
│ └── RELEASE_TEMPLATE.md
113+
├── scripts/
114+
│ └── build-html-release.js
115+
├── index.html
116+
├── mobile.html
117+
├── package.json
118+
├── README.md
119+
├── README.zh-CN.md
120+
└── .github/workflows/
121+
├── build-html.yml
122+
└── release.yml
123+
```
48124

49125
## Notes
50126

51-
- This repository currently focuses on the web version only
127+
- This repository currently focuses on web delivery only, not EXE packaging
52128
- Medical content is for informational use only and does not replace formal clinical decision-making

‎README.zh-CN.md‎

Lines changed: 92 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,128 @@
11
<div align="center">
22
<h1>Thyroid TNM Tool</h1>
3-
<p><strong>甲状腺癌 TNM 分期与治疗计划网页工具,含 PC 原版与独立手机版</strong></p>
3+
<p><strong>更像产品页展示的甲状腺癌 TNM 分期网页工具,含 PC 原版与独立手机版。</strong></p>
44
<p><strong>简体中文</strong> | <a href="README.md">English</a></p>
5+
56
<p>
67
<a href="https://github.com/liqi3333/thyroid/releases/latest"><img alt="最新版本" src="https://img.shields.io/github/v/release/liqi3333/thyroid?display_name=tag&label=release" /></a>
8+
<a href="https://github.com/liqi3333/thyroid/releases"><img alt="下载次数" src="https://img.shields.io/github/downloads/liqi3333/thyroid/total?label=downloads" /></a>
79
<a href="https://github.com/liqi3333/thyroid/actions/workflows/build-html.yml"><img alt="构建 HTML" src="https://github.com/liqi3333/thyroid/actions/workflows/build-html.yml/badge.svg" /></a>
810
<a href="https://github.com/liqi3333/thyroid/actions/workflows/release.yml"><img alt="发布 HTML" src="https://github.com/liqi3333/thyroid/actions/workflows/release.yml/badge.svg" /></a>
911
</p>
12+
1013
<p>
11-
<a href="https://liqi3333.github.io/thyroid/"><img alt="在线打开" src="https://img.shields.io/badge/在线打开-网页-0ea5e9?style=for-the-badge" /></a>
14+
<a href="https://liqi3333.github.io/thyroid/"><img alt="打开 PC 网页" src="https://img.shields.io/badge/打开-PC%20网页-0ea5e9?style=for-the-badge" /></a>
1215
<a href="https://liqi3333.github.io/thyroid/mobile.html"><img alt="打开手机版网页" src="https://img.shields.io/badge/打开-手机版网页-f59e0b?style=for-the-badge" /></a>
13-
<a href="https://github.com/liqi3333/thyroid/releases/latest"><img alt="下载 HTML" src="https://img.shields.io/badge/下载-最新%20HTML-10b981?style=for-the-badge" /></a>
16+
<a href="https://github.com/liqi3333/thyroid/releases/latest"><img alt="下载最新 HTML" src="https://img.shields.io/badge/下载-最新%20HTML-10b981?style=for-the-badge" /></a>
1417
</p>
1518
</div>
1619

1720
## 项目简介
1821

19-
这个项目把甲状腺癌 TNM 分期、治疗计划与随访建议工具,整理成了一个同时提供 PC 原版网页和独立手机版网页的 GitHub 项目。
22+
Thyroid TNM Tool 现在不只是一个单文件 HTML,而是已经整理成一个可公开访问、可自动发布、可在线使用的产品化网页项目。
23+
24+
当前提供两个明确分开的入口:
25+
26+
- **PC 网页版**:保留原始桌面布局与阅读体验
27+
- **手机版网页**:单独的 `mobile.html`,专门为手机浏览器优化
2028

21-
## 入口
29+
## 这个项目现在有什么价值
30+
31+
- 可快速查看甲状腺癌 AJCC 第 8 版 TNM 分期
32+
- 在同一页面查看治疗计划与随访建议
33+
- 无需后端,无需安装,网页可直接打开
34+
- 既可在线使用,也可下载独立 HTML 离线打开
35+
- 不强行做成同一套响应式,而是把 PC 和手机体验拆开做
36+
37+
## 访问入口
2238

2339
- GitHub 仓库:<https://github.com/liqi3333/thyroid>
24-
- 在线 PC 页面:<https://liqi3333.github.io/thyroid/>
25-
- 在线手机版页面:<https://liqi3333.github.io/thyroid/mobile.html>
40+
- PC 在线页面:<https://liqi3333.github.io/thyroid/>
41+
- 手机在线页面:<https://liqi3333.github.io/thyroid/mobile.html>
2642
- 最新 Release:<https://github.com/liqi3333/thyroid/releases/latest>
43+
- 全部 Releases:<https://github.com/liqi3333/thyroid/releases>
44+
45+
## 当前交付形态
46+
47+
仓库目前提供以下交付方式:
48+
49+
- `index.html`,PC 原版网页
50+
- `mobile.html`,独立手机版网页
51+
- Release 附件:`Thyroid-TNM-Tool-1.0.1.html`
52+
- Release 附件:`Thyroid-TNM-Tool-mobile-1.0.1.html`
53+
54+
## 快速开始
55+
56+
### 直接在线使用
57+
58+
- 打开 PC 网页:<https://liqi3333.github.io/thyroid/>
59+
- 打开手机版网页:<https://liqi3333.github.io/thyroid/mobile.html>
60+
61+
### 下载独立 HTML
2762

28-
## 本地使用
63+
从这里下载最新版本:
2964

30-
直接用浏览器打开 `index.html` 即可,或者运行构建命令生成发布版 HTML:
65+
- <https://github.com/liqi3333/thyroid/releases/latest>
66+
67+
下载后,直接用浏览器打开任意 HTML 文件即可。
68+
69+
### 本地构建
3170

3271
```bash
3372
npm run build:html
3473
```
3574

36-
产物:
75+
构建产物:
3776

3877
```text
3978
dist-html/Thyroid-TNM-Tool-1.0.1.html
4079
dist-html/Thyroid-TNM-Tool-mobile-1.0.1.html
4180
```
4281

43-
## 自动化流程
82+
## 产品亮点
83+
84+
- 甲状腺癌 TNM 分期界面
85+
- 治疗计划与随访建议面板
86+
- 可独立分发的 HTML 版本
87+
- PC 与手机分开的双入口网页
88+
- GitHub Pages 在线部署
89+
- GitHub Actions 自动构建与自动发布
90+
- 中英文双语文档
91+
92+
## 自动发布流程
93+
94+
仓库已内置 GitHub Actions 自动化交付流程。
95+
96+
- 推送到 `main`:执行构建检查,并上传 HTML artifact
97+
- 推送形如 `v1.0.1` 的标签:自动生成 PC + 手机版独立 HTML,并发布到 GitHub Releases
98+
- GitHub Pages 同时托管 `index.html` 与 `mobile.html`
99+
100+
示例:
44101

45-
- 推送到 `main`:自动构建 HTML,并上传 PC + 手机版 artifact
46-
- 推送形如 `v1.0.1` 的标签:自动生成 PC/手机版独立 HTML 文件并发布到 GitHub Releases
47-
- GitHub Pages 直接托管 `index.html` 和 `mobile.html`
102+
```bash
103+
git tag v1.0.1
104+
git push origin v1.0.1
105+
```
106+
107+
## 项目结构
108+
109+
```text
110+
.
111+
├── docs/
112+
│ └── RELEASE_TEMPLATE.md
113+
├── scripts/
114+
│ └── build-html-release.js
115+
├── index.html
116+
├── mobile.html
117+
├── package.json
118+
├── README.md
119+
├── README.zh-CN.md
120+
└── .github/workflows/
121+
├── build-html.yml
122+
└── release.yml
123+
```
48124

49-
## 说明
125+
## 注意事项
50126

51-
- 当前仓库只做网页版本,不含 EXE
127+
- 当前仓库只做网页交付,不含 EXE
52128
- 医学内容仅供信息参考,不替代正式临床决策

0 commit comments

Comments
 (0)