diff --git a/README.md b/README.md index cf86353..7094496 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,36 @@ # bmi-tdee-calculator -BMI 计算与每日热量需求(BMR/TDEE)计算器 \ No newline at end of file +BMI 计算与每日热量需求(BMR/TDEE)计算器 + +## 文件说明 + +| 文件 | 说明 | +| --- | --- | +| `index.html` | 网页版「每日热量需求与膳食计算器」,直接打开即可使用(React + Tailwind,免构建) | +| `CalorieCalculator.jsx` | 网页所用的 React 组件源码,需要接入打包项目时可直接引用 | +| `bmi_calculator.py` | 命令行版 BMI 计算器 | + +> 说明:原先的 `tdee_calculator.py` 其实是一段 React 代码(扩展名写错了), +> 现已整理为 `CalorieCalculator.jsx`,并做成了可直接打开的 `index.html`。 + +## 网页版功能 + +- 输入性别 / 年龄 / 身高 / 体重 / 每日步数 +- Mifflin-St Jeor 公式算 BMR,结合步数区间系数得到 TDEE,并给出「维持热量 + 300 千卡」的增重目标 +- 蛋白质 / 脂肪 / 碳水三大产能营养素目标 +- 早餐 / 午餐 / 晚餐 / 加餐:每餐可点选替换食材,实时汇总热量与营养素 +- 膳食纤维、钙、铁、锌、维生素 A / C、水分的摄入量与参考值进度条 + +## 使用方式 + +直接双击打开 `index.html` 即可(首次加载需联网获取 CDN 上的 React / Tailwind)。 + +## 部署为网站 + +在仓库「设置 → 页面(Page)」中启用站点,分支选 `main`、目录填根目录 `/`,保存后即可通过 Pages 地址访问。 + +## 命令行版 + +```bash +python3 bmi_calculator.py +```