Skip to content

Commit 01f5e95

Browse files
Charliechen114514Charliechen114514
committed
base: tidy up
1 parent 78a7f56 commit 01f5e95

4 files changed

Lines changed: 78 additions & 5 deletions

File tree

‎.github/workflows/build-check.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Build Check
2+
3+
on:
4+
pull_request:
5+
branches: [main]
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- name: Checkout
13+
uses: actions/checkout@v4
14+
with:
15+
fetch-depth: 0
16+
17+
- name: Setup Node.js
18+
uses: actions/setup-node@v4
19+
with:
20+
node-version: '22'
21+
22+
- name: Setup pnpm
23+
uses: pnpm/action-setup@v4
24+
with:
25+
version: 10
26+
27+
- name: Install dependencies
28+
run: pnpm install --frozen-lockfile
29+
30+
- name: Restore build cache
31+
uses: actions/cache@v4
32+
with:
33+
path: site/.vitepress/cache
34+
key: vitepress-build-${{ runner.os }}-${{ hashFiles('tutorial/**', 'site/.vitepress/config/**', 'site/.vitepress/plugins/**', 'site/.vitepress/public/**', 'site/.vitepress/theme/**', 'project.config.ts', 'package.json', 'pnpm-lock.yaml') }}
35+
restore-keys: |
36+
vitepress-build-${{ runner.os }}-
37+
vitepress-build-
38+
39+
- name: Build
40+
run: pnpm build
41+
env:
42+
NODE_OPTIONS: --max-old-space-size=6144

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2025 Charliechen114514
3+
Copyright (c) 2025-2026 Charliechen114514
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.md‎

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
11
# EmbedBox
22

3+
![License](https://img.shields.io/github/license/Awesome-Embedded-Learning-Studio/EmbedBox)
4+
![Build](https://img.shields.io/github/actions/workflow/status/Awesome-Embedded-Learning-Studio/EmbedBox/deploy.yml?branch=main)
5+
36
> 嵌入式开发通用工具链教程——不管走哪条嵌入式航线，都要先会用的工具：终端 / Git / Markdown / GCC / Make / CMake / GDB / 交叉编译 / 串口 / Docker / QEMU。
47
5-
本教程创建于 2025-12-09 · 作者 Charliechen114514 · 联系方式 725610365@qq.com
8+
🌐 **[在线文档站](https://awesome-embedded-learning-studio.github.io/EmbedBox/)**
9+
10+
作者 Charliechen114514 · 联系方式 725610365@qq.com
611

712
本项目隶属于组织 [Awesome-Embedded-Learning-Studio](https://github.com/Awesome-Embedded-Learning-Studio) 的文档教程体系。
813

914
## 这是什么？
1015

11-
EmbedBox 是面向嵌入式开发者的「公共语言」入门坡道：在进入 AwesomeQt / ModernCPP / PenguinLab / 各 forge 之前，先把终端、Git、Markdown、编译链、CMake、GDB、交叉编译、串口这些通用工具学会。它只负责把工具教透，不替中心站 [Awesome-Embedded](https://github.com/Awesome-Embedded-Learning-Studio/Awesome-Embedded) 做导航。
16+
EmbedBox 是面向嵌入式开发者的「公共语言」入门坡道：在进入 AwesomeQt / ModernCPP / PenguinLAB / 各 forge 之前，先把终端、Git、Markdown、编译链、CMake、GDB、交叉编译、串口这些通用工具学会。它只负责把工具教透，不替中心站 [Awesome-Embedded](https://github.com/Awesome-Embedded-Learning-Studio/Awesome-Embedded) 做导航。
17+
18+
**适合谁？** 刚起步的嵌入式自学者 · 只会一点 PowerShell / 命令行的硬件朋友 · 想补齐「工具链前置知识」再啃具体航线的开发者。
1219

1320
## 快速目录
1421

@@ -27,6 +34,20 @@ pnpm build # 构建到 site/.vitepress/dist
2734
pnpm preview # 预览构建产物
2835
```
2936

30-
教程正文 Markdown 在 [`tutorial/`](./tutorial/index.md)；配套的示例代码 / 硬件电路图 / PCB 等资产放在 [`examples/`](./examples/instructions.md)，规则见该目录说明。
37+
## 项目结构
38+
39+
| 目录 / 文件 | 内容 |
40+
|---|---|
41+
| [`tutorial/`](./tutorial/index.md) | 教程正文 Markdown（WSL / Markdown / Git 等） |
42+
| [`site/`](./site/) | VitePress 站点配置、主题、插件（`.vitepress/`） |
43+
| [`examples/`](./examples/instructions.md) | 配套示例代码 / 硬件电路图 / PCB 等资产 |
44+
| [`project.config.ts`](./project.config.ts) | 站点元信息（名称、导航、侧栏 volume 等） |
45+
46+
推送到 `main` 分支会自动经 GitHub Actions 构建并部署到 GitHub Pages；提 PR 时 `Build Check` 会自动跑 `pnpm build` 校验（含死链检查）。
47+
48+
## 许可证与联系方式
3149

32-
推送到 `main` 分支会自动经 GitHub Actions 构建并部署到 GitHub Pages。
50+
- **许可证**：[MIT License](./LICENSE)
51+
- **Issues**：[提交问题](https://github.com/Awesome-Embedded-Learning-Studio/EmbedBox/issues)
52+
- **Email**：725610365@qq.com
53+
- **组织**：[Awesome-Embedded-Learning-Studio](https://github.com/Awesome-Embedded-Learning-Studio)

‎package.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@
33
"version": "0.0.1",
44
"private": true,
55
"type": "module",
6+
"license": "MIT",
7+
"engines": {
8+
"node": ">=22",
9+
"pnpm": ">=10"
10+
},
11+
"packageManager": "pnpm@10.33.3",
12+
"repository": {
13+
"type": "git",
14+
"url": "https://github.com/Awesome-Embedded-Learning-Studio/EmbedBox.git"
15+
},
616
"scripts": {
717
"dev": "vitepress dev site",
818
"build": "vitepress build site",

0 commit comments

Comments
 (0)