Skip to content

Commit 5ae947b

Browse files
Update: Using Site instead of simple markdown to show content
1 parent ce75ac1 commit 5ae947b

81 files changed

Lines changed: 7480 additions & 3630 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/deploy.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Deploy VitePress
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: write
11+
12+
jobs:
13+
deploy:
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- name: Checkout
18+
uses: actions/checkout@v4
19+
with:
20+
fetch-depth: 0
21+
22+
- name: Setup Node.js
23+
uses: actions/setup-node@v4
24+
with:
25+
node-version: '22'
26+
27+
- name: Setup pnpm
28+
uses: pnpm/action-setup@v4
29+
with:
30+
version: 10
31+
32+
- name: Install dependencies
33+
run: pnpm install --frozen-lockfile
34+
35+
- name: Build
36+
run: pnpm build
37+
38+
- name: Deploy to GitHub Pages
39+
uses: peaceiris/actions-gh-pages@v4
40+
with:
41+
github_token: ${{ secrets.GITHUB_TOKEN }}
42+
publish_dir: ./site/.vitepress/dist

.gitignore

Lines changed: 46 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,47 @@
1-
# Claude Code小助手
1+
# Claude Code
22
CLAUDE.md
3-
# 一些脚本运行的元数据
4-
data/
3+
.claude/
4+
5+
# 本地仓库克隆(绝对不能提交)
6+
content/
7+
8+
# 私有 manifest(绝对不能提交)
9+
manifest/*.local.yaml
10+
manifest/*.local.*
11+
12+
# 私有报告(绝对不能提交)
13+
reports/internal-*.md
14+
reports/private-*.md
15+
16+
# 审计中间结果
17+
audit-result.local.json
18+
audit-output.local.json
19+
*.local.json
20+
21+
# 元数据
22+
data/
23+
24+
# Python
25+
__pycache__/
26+
*.py[cod]
27+
*.pyo
28+
.venv/
29+
venv/
30+
*.egg-info/
31+
32+
# Node.js / VitePress
33+
node_modules/
34+
site/.vitepress/dist/
35+
site/.vitepress/cache/
36+
37+
# 缓存和临时文件
38+
.cache/
39+
.tmp/
40+
*.tmp
41+
42+
# 密钥和敏感信息
43+
.env
44+
secrets/
45+
*.key
46+
*.pem
47+
*.secret

ProjectLists.todo/ProjectLists.todo.md

Lines changed: 0 additions & 44 deletions
This file was deleted.

ProjectLists.todo/gadgets/index.md

Whitespace-only changes.

ProjectLists.todo/projects/index.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

ProjectLists.todo/projects/project.sub/index.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

ProjectLists.todo/tutorials/index.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

README.md

Lines changed: 32 additions & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -1,138 +1,54 @@
1-
# Hello, Awesome-Embedded! 🚀
1+
# Hello, Awesome-Embedded!
22

3-
> 本仓库是Awesome-Embedded-Learning-Studio的中心仓库,从这里出发!来看看本嵌入式学习工作室的嵌入式小玩具产品项目的所有子仓库目录!
4-
> 这些仓库中将会包含所有学习工作室的嵌入式小玩具的所有开源资料,包含但是不限于代码,硬件PCB设计和相关的教学文档。
5-
6-
---
3+
> 这里是 [Awesome-Embedded-Learning-Studio](https://github.com/Awesome-Embedded-Learning-Studio) 的大厅。不管你是想学嵌入式、找开源项目、还是想贡献代码,从这里出发就对了。
74
85
<p align="center">
9-
<img alt="rocket" src="https://img.shields.io/badge/Studio-Awesome--Embedded-orange" />
10-
<img alt="status" src="https://img.shields.io/badge/status-WIP-yellow" />
6+
<a href="https://awesome-embedded-learning-studio.github.io/Awesome-Embedded/">
7+
<img src="https://img.shields.io/badge/文档站-在线阅读-blue?logo=vitepress" alt="Docs" />
8+
</a>
119
<img alt="license" src="https://img.shields.io/badge/license-MIT-lightgrey" />
12-
<img alt="C" src="https://img.shields.io/badge/C-language-blue?logo=c&logoColor=white" />
13-
<img alt="C++" src="https://img.shields.io/badge/C++-modern-blueviolet?logo=c%2B%2B&logoColor=white" />
14-
<img alt="Python" src="https://img.shields.io/badge/Python-🐍-informational?logo=python&logoColor=white" />
15-
<img alt="Qt" src="https://img.shields.io/badge/Qt-UI-lightgrey?logo=qt&logoColor=white" />
16-
<img alt="Embedded Linux" src="https://img.shields.io/badge/Embedded--Linux-Linux-lightgrey?logo=linux&logoColor=white" />
17-
<img alt="STM32" src="https://img.shields.io/badge/STM32-MCU-success?logo=arm&logoColor=white" />
18-
<img alt="嘉立创/AD" src="https://img.shields.io/badge/嘉立创_AD-嘉立创_AD-orange?logo=kicad&logoColor=white" />
19-
<img alt="GitHub Actions" src="https://img.shields.io/badge/CI-GitHub%20Actions-black?logo=githubactions&logoColor=white" />
20-
</p>
21-
22-
![Awesome-Embedded](./assets/Awesome-Embedded.png)
23-
24-
> 快速定位:这是我们组织的**中心仓库** —— 把所有小玩具的 Repo 当作分支园地,来这里就能知道正在做什么、谁在做、下一个任务是什么。
25-
26-
## 🔎 目录
27-
28-
- [关于](#hello-awesome-embedded)
29-
- [从这里出发...](#从这里出发...)
30-
- [目前为止,这个组织都有谁?](#目前为止这个组织都有谁)
31-
- [我们的 WIP 计划](#我们的wip计划)
32-
- [项目清单与模板 (TODO)](#项目清单与模板-todo)
33-
- [开发规范?迭代周期说明?](#开发规范?迭代周期说明?)
34-
- [许可 & 联系方式](#许可--联系方式)
35-
36-
---
37-
38-
## 从这里出发...
39-
40-
[点击我跳转到仓库大厅...🖱](roadmap.md)
41-
42-
## 目前为止,这个组织都有谁?
43-
44-
- [HNHKHNH](https://github.com/HNHKHNH):硬件大牛,PCB工程师
45-
- [Charliechen114514](https://github.com/Charliechen114514):一般路过的普通C/C++程序员
46-
47-
---
48-
49-
## 我们的 WIP 计划
50-
51-
- [x] 完成进一步对本Organization的初始化,包括中心仓库,初步的ReadME Profile (需要进一步同 [HNHKHNH](https://github.com/HNHKHNH) 进行协商)
52-
- [x] 初步完成对一个嵌入式小产品的模拟迭代工作流,产出一份说明计划文档准备讨论
53-
- [x] 预计产出一个Repo Template作为模板
54-
- [x] 明确我们打算预备做的小产品清单,单列出来一张ProjectLists.todo.md,随后[HNHKHNH](https://github.com/HNHKHNH)[Charliechen114514](https://github.com/Charliechen114514)约定好具体的第一个试手工程
55-
- [x] [Charliechen114514](https://github.com/Charliechen114514) 基础协作框架已完善(repo template、audit 脚本、community Discussions、roadmap)
56-
- [x] 美化这个Readme,嗯,看起来好看点,至少(
57-
58-
> 我们把上面的 WIP 当作活页,随时更新:每个条目完成后会在这里打勾并链接到对应的 Repo / PR / Issue。
59-
60-
---
61-
62-
## ✨ 我们的目标(短句)
63-
64-
- 做"能学到东西"的小玩具,而不是仅仅展示工程;
65-
- 每个项目要有完整的入门文档、PCB、固件和教学资料;
66-
- 建立一套小而可复用的 Repo Template,方便快速起步;
67-
- 鼓励开源与分享,让更多同好者能参与进来。
68-
69-
---
70-
71-
## 技术栈 🧰
72-
73-
下面是我们常用 / 计划使用的技术栈:
74-
75-
<p align="left">
76-
<img src="https://img.shields.io/badge/C-language-blue?logo=c&logoColor=white" alt="C" />
77-
<img src="https://img.shields.io/badge/C++-modern-blueviolet?logo=c%2B%2B&logoColor=white" alt="C++" />
78-
<img src="https://img.shields.io/badge/Python-🐍-informational?logo=python&logoColor=white" alt="Python" />
79-
<img src="https://img.shields.io/badge/Qt-UI-lightgrey?logo=qt&logoColor=white" alt="Qt" />
80-
<img src="https://img.shields.io/badge/Embedded--Linux-Linux-lightgrey?logo=linux&logoColor=white" alt="Embedded Linux" />
81-
<img src="https://img.shields.io/badge/STM32-MCU-success?logo=arm&logoColor=white" alt="STM32" />
82-
<img alt="嘉立创/AD" src="https://img.shields.io/badge/嘉立创_AD-嘉立创_AD-orange?logo=kicad&logoColor=white" />
83-
<img src="https://img.shields.io/badge/GitHub%20Actions-CI-black?logo=githubactions&logoColor=white" alt="GitHub Actions" />
10+
<img alt="repos" src="https://img.shields.io/badge/公开仓库-21-blue" />
8411
</p>
8512

8613
---
8714

88-
## 📦项目清单与模板 (TODO)
15+
## 文档站
8916

90-
#### 📦 仓库说明
17+
完整的组织导航、项目矩阵和路线图已迁移到 VitePress 文档站:
9118

92-
本仓库用于集中管理:
19+
**[https://awesome-embedded-learning-studio.github.io/Awesome-Embedded/](https://awesome-embedded-learning-studio.github.io/Awesome-Embedded/)**
9320

94-
- **📋 项目清单**[`ProjectLists.todo.md`](./ProjectLists.todo/ProjectLists.todo.md)
21+
包含:
22+
- **新手引导** — 不知道从哪里开始?按身份快速定位
23+
- **项目一览** — 按四条主航道分类的完整项目矩阵
24+
- **组织路线图** — 学习路线、建设规划和维护优先级
25+
- **贡献指南** — 如何参与贡献
26+
- **维护者** — 核心团队介绍
9527

96-
> 存放所有「待做小产品」及其优先级规划。
28+
## 四条主航道
9729

98-
- **🧩 项目模板集合**[`repo-template/`](./repo-template/)
30+
| 方向 | 核心仓库 |
31+
|------|----------|
32+
| C++ 入门学习与工程化 | Tutorial_AwesomeModernCPP · miniwget · CFBox |
33+
| Embedded Linux | imx-forge · rk-forge · PenguinLab |
34+
| MCU / 裸机 / FreeRTOS | ST-Forge · BareMetal-Drivers · Project_MicroWatch |
35+
| Qt / GUI / 产品化 | Tutorial_AwesomeQt · CFDesktop · qt-compile-pipeline |
9936

100-
> 一个「最小可运行」的小产品模板,包含 **PCB 目录、Firmware、Docs、CI 配置示例**等内容。
101-
>
102-
> 🔗 快速跳转:
103-
>
104-
> - [📘 项目模板](./repo-template/repo-project-template)
105-
> - [📙 教程模板](./repo-template/repo-tutorial-template)
37+
## 快速链接
10638

107-
------
39+
- [项目模板](repo-template/) — 创建新项目的模板
40+
- [工具脚本](tools/) — 自动化模板生成
41+
- [社区讨论](https://github.com/Awesome-Embedded-Learning-Studio/community/discussions)
10842

109-
#### 🛠 贡献者须知
43+
## 贡献者
11044

111-
> 为了提升项目开发效率,我们提供了自动创建项目/教程模板的工具脚本。
45+
- [Charliechen114514](https://github.com/Charliechen114514) — C/C++ 程序员
46+
- [HNHKHNH](https://github.com/HNHKHNH) — 硬件大牛,PCB 工程师
11247

113-
- 👉 **脚本作者:** [Charliechen114514](https://github.com/Charliechen114514)
114-
- 👉 **脚本位置:** [`./tools`](./tools)
115-
- 👉 **如何使用:** 根据您的 Shell 环境选择相应脚本执行,即可在本地自动化生成完整项目骨架。
48+
## 许可
11649

117-
📅 **首个试手工程已启动,多个项目正在进行中。** 对应的项目仓库(Repo)已创建,欢迎关注进展!
50+
MIT License
11851

11952
---
12053

121-
## 开发规范?迭代周期说明?
122-
123-
我们的开发规范与迭代周期说明是灵活的,目前,涉及到教程和工程的所有文档都是草稿,已经上传到了draft目录下:[草稿🖱](drafts)
124-
125-
## 工具文档集合
126-
127-
这里工具教程文档:[点击我进行阅读](./tools/README.md)
128-
129-
## 许可 & 联系方式
130-
131-
- 许可:MIT
132-
- 联系:在 GitHub Issue / PR 中 @ 对应用户名,或者直接用仓库 Discussions。
133-
134-
---
135-
136-
> 感谢阅读!如果你看到这里了,说明你对嵌入式也有一丁点好奇 —— 欢迎关注我们,一起把小玩具做成好玩的教程 & 项目!芜湖起飞🚀
137-
138-
<p align="center">✨ Keep it small, make it fun — Awesome-Embedded-Learning-Studio</p>
54+
<p align="center">Keep it small, make it fun — Awesome-Embedded-Learning-Studio</p>

0 commit comments

Comments
 (0)