Skip to content

OVERVIEW.md

Latest commit

 

History

History
181 lines (132 loc) · 6.79 KB

OVERVIEW.md

File metadata and controls

181 lines (132 loc) · 6.79 KB
Raw

开源项目发布总览

已生成的文件清单

下面所有文件都已在 D:\EveryProJect\workbudy\opensource-scaffold\ 目录下生成。

README 与基础文件

文件 说明 状态
README.md 精美 README，含 Banner、徽章、真实截图、功能列表、路线图 已生成
LICENSE GPL v3 完整许可证文本 已生成
.gitignore 适配嵌入式 C/C++ + Qt + EDA 项目的忽略规则 已生成
CHANGELOG.md 基于 Keep a Changelog 规范的版本记录 已生成
CONTRIBUTING.md 含代码规范、提交规范、PR 流程 已生成
CODE_OF_CONDUCT.md 基于 Contributor Covenant 2.1 已生成
OVERVIEW.md 本文件：发布与维护总览 已生成

GitHub 平台配置

文件 说明 状态
.github/ISSUE_TEMPLATE/bug_report.yml 结构化 Bug 报告表单 已生成
.github/ISSUE_TEMPLATE/feature_request.yml 结构化功能建议表单 已生成
.github/ISSUE_TEMPLATE/config.yml 禁用空白 Issue + 联系链接 已生成
.github/PULL_REQUEST_TEMPLATE.md PR 提交检查清单 已生成
.github/FUNDING.yml GitHub Sponsors 配置（已注释，按需启用） 已生成
.github/CODEOWNERS 自动指派各模块 Reviewer 已生成
.github/workflows/ci.yml GitHub Actions：LoongArch 交叉编译 + 代码格式检查 已生成

视觉资源

文件 说明 状态
assets/banner.png README 顶部横幅（2400×400） 已生成
assets/social-preview.png 社交分享预览图（1280×640） 已生成
assets/app-install.jpg 手机 APP「龙辰星曜」安装页 已添加
assets/app-monitor.jpg APP 实时监测页 已添加
assets/app-control.jpg APP 远程控制页 已添加
assets/app-settings.jpg APP 设置页 已添加
assets/display-dashboard.jpg 龙芯本地 Qt 监控大屏 已添加
assets/board-main.jpg 龙芯 2K0300 主控板 已添加
assets/board-power.jpg QC3+ 电源输出板 已添加
assets/test-setup-photo.jpg 现场测试照片 已移动
generate_preview.py 图片生成脚本 已生成

文档

文件 说明 状态
docs/build-guide.md 编译、烧录、APP 使用指南 已完善
docs/hardware-setup.md 硬件接线、BOM、I2C/ADC 说明 已完善
docs/protocol.md UDP 8888 通信协议与命令格式 已完善

发布到 GitHub 的步骤

1. 在 GitHub 创建仓库

  1. 打开 https://github.com/new
  2. 填写仓库名（如 longchen-xingyao 或 smart-universal-charger）
  3. 描述：基于龙芯 2K0300 的三源融合智能充电与供电系统 | 龙辰星曜 · 智能万能充
  4. 选 Public（公开）
  5. 不要勾选 "Add a README" / "Add .gitignore"（我们自己写好了）
  6. 点击 Create repository

2. 设置仓库

进入 Settings：

  • About 区域（右上角齿轮）：

    • Description: 龙辰星曜 · 智能万能充：基于龙芯 2K0300 的三源融合智能充电与供电系统
    • Website: 你的项目主页（可选）
    • Topics: loongson, loongarch, embedded, mppt, charger, renewable-energy, solar, wind-energy, kinetic-energy, qc3, fast-charging, qt, iot, open-hardware, china
    • ✨ 勾选 Releases、Packages、Sponsorships

  • Social preview：

    • 上传 assets/social-preview.png（1280×640）

  • Features：

    • ✨ Issues
    • ✨ Discussions（强烈建议开启，用于问答和功能讨论）
    • ✨ Wiki（可选）
    • ✨ Projects（可选）

3. 初始化本地 Git 并推送

cd D:\EveryProJect\workbudy\opensource-scaffold

# 初始化（如果还没 git）
git init
git add .
git commit -m "chore: initial open source release"
git branch -M main
git remote add origin https://github.com/你的用户名/你的仓库名.git
git push -u origin main

4. 创建首个 Release

git tag -a v1.0.0 -m "首个开源版本 v1.0.0"
git push origin v1.0.0

然后到 GitHub Releases 页面编辑 v1.0.0，写 Release Notes 并附带固件（可选）。

让别人"惹人注目"

发布后，做这几件事能大幅提升曝光：

a) 添加到 awesome 列表

搜索 awesome-iot awesome-embedded awesome-chinese-opensource awesome-loongson 等仓库，按它们的指南提 PR。

b) 写技术博客

  • 掘金 / 思否 / 知乎
  • 少数派
  • CSDN / OSCHINA
  • V2EX（/go/openSource 节点）
  • 微信公众号

c) 短视频 / 图文平台

  • B 站：拍摄「龙芯 + 三源充电」实物演示视频
  • 抖音 / 小红书：展示手机 APP 控制 LED、风扇、输出电压

d) 海外社区

  • Reddit: r/embedded, r/raspberry_pi, r/IoT, r/solar
  • Hacker News: news.ycombinator.com

发布前必做事项

  1. 替换占位符：

    • 全局搜索 你的用户名 替换为你的 GitHub 用户名
    • 全局搜索 your-repo 替换为你的仓库名
    • 替换 your-email@example.com 为你的真实邮箱
    • 替换 https://github.com/你的用户名/your-repo 为真实链接

  2. 检查敏感信息：

    • git grep -iE 'password|secret|token|api[-_]?key'
    • 移除任何 WiFi 密码、个人凭证、私有 IP（如 phone_ip 可保留默认值，但建议说明用户需修改）

  3. 确认图片引用：

    • 所有 assets/*.jpg 文件名与 README 中引用一致
    • 图片不要太大（单张建议 < 2MB）

  4. 测试 CI：

    • 推送后访问 Actions 页面
    • 第一次 CI 可能因工具链下载链接失效，按需调整 .github/workflows/ci.yml

  5. 完善项目内容（可选但推荐）：

    • 补充 PCB 源文件（Altium / KiCad）到 hardware/ 目录
    • 补充外壳 3D 模型到 hardware/enclosure/
    • 补充 APP 源码或 APK 下载链接
    • 写更详细的性能测试报告

项目亮点话术（用于博客/README 顶部）

龙辰星曜 · 智能万能充 是一套基于国产龙芯 2K0300 处理器的三源融合智能充电与供电系统。它能同时接入动能、风能、太阳能三种可再生能源，支持 LiPo / LiFePO4 / NiMH / 铅酸 4 种电池，配套 Qt 本地监控大屏与手机 APP 远程控制，具备 PWM 风扇温控、RGB 氛围灯、TPL0401B 输出调压、QC3+ 快充输出、OTA 预留升级等能力，验证了国产 LoongArch 芯片在新能源管理与户外供电领域的应用潜力。

后续维护建议

  • 每周处理 Issue — 快速响应能留住关注者
  • 每月发版 — 保持活跃度
  • 写 CHANGELOG — 每次发版都更新
  • 接受 PR 时加 credit — 在 README Contributors 区域列出贡献者
  • 回答 Discussions — 适合问答交流
  • 打 Tag 习惯 — 重要功能/修复都打 tag