Skip to content

Commit dcd31b6

Browse files
committed
更新 README.md,添加构建和开发指令;修改文档规范中的术语说明
1 parent c799d25 commit dcd31b6

File tree

2 files changed

+35
-10
lines changed

2 files changed

+35
-10
lines changed

README.md

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# 梦猫大典 - Mdr-C-Tutorial 教程讲义及示例代码开源仓库
22

3+
[![GitHub Repo stars](https://img.shields.io/github/stars/Mdr-C-Tutorial/C)](https://github.com/Mdr-C-Tutorial/C)
4+
[![License](https://img.shields.io/badge/license-CC%20BY--NC--SA%204.0-lightgrey.svg)](LICENSE)
5+
[![Language](https://img.shields.io/badge/language-C-333.svg)](https://en.cppreference.com/w/c/language.html)
6+
[![VitePress](https://img.shields.io/badge/built%20with-VitePress-646cff.svg)](https://vitejs.cn/vitepress/)
7+
[![GitHub Actions](https://github.com/Mdr-C-Tutorial/C/actions/workflows/deploy.yml/badge.svg)](https://github.com/Mdr-C-Tutorial/C/actions)
8+
39
## 快去 star
410

511
[![Star History Chart](https://api.star-history.com/svg?repos=Mdr-C-Tutorial/C&type=date&legend=top-left)](https://www.star-history.com/#Mdr-C-Tutorial/C&type=date&legend=top-left)
@@ -35,6 +41,17 @@ int main(int argc, char* argv[]){
3541
1. 本文档使用 [VitePress](https://vitejs.cn/vitepress/) 构建,需最新版 pnpm 以在本地 build 和 dev。
3642
2. 本仓库采用 [GitHub Actions](https://github.com/features/actions) 在每次提交时自动构建和部署。
3743
44+
```bash
45+
# 安装依赖
46+
pnpm i
47+
48+
# 启动本地开发服务器
49+
pnpm dev
50+
51+
# 构建静态文件
52+
pnpm build
53+
```
54+
3855
## 文档规范
3956

4057
该栏为本仓库 markdown 文档的规范。
@@ -58,16 +75,16 @@ int main(int argc, char* argv[]){
5875
13. 要正确使用标点符号,分清**顿号****逗号****分号****句号**,尤其避免一逗到底;
5976
14. 分清**的地得****他她它**
6077
15. 仅在必要时使用**数量词**(尤其警惕**一个**的不恰当使用)
61-
16. 在**术语** (Terminology) 首次出现的时候在**半角小括号**内给出**对应的外来语**,同时给出**首字母缩略语** (Acronym)。这些外来语通常对应**概念** (Concept) 的原文,希望有助于读者明确分辨词语的含义:
78+
16.**术语** (Terminology) 首次出现的时候在**半角小括号**内给出**对应的英文原词**,同时给出**首字母缩略语** (Acronym)。这些英文原词通常对应**概念** (Concept) 的原文,希望有助于读者明确分辨词语的含义:
6279
1. 为减少读者的记忆负担,下文分情况使用**术语的汉语表述****首字母缩略语**:初始章节以前者为主,进阶章节以后者为主
63-
2. 外来语和缩略语可能视情况在不同章节多次出现
80+
2. 英文原词和缩略语可能视情况在不同章节多次出现
6481
3. 括号外左侧右侧各空一个空格,括号内无空格
65-
4. 外来语**不能**带斜体、加粗、下划线、删除线和代码块——用默认的字体;
66-
5. 大部分外来语单词摘自 [维基百科](https://zh.wikipedia.org) 和 [C++ 参考手册](https://en.cppreference.com/);
82+
4. 英文原词**不能**带斜体、加粗、下划线、删除线和代码块——用默认的字体;
83+
5. 大部分英文原词单词摘自 [维基百科](https://zh.wikipedia.org)[C++ 参考手册](https://en.cppreference.com/)
6784
17. 专有名词需大写;
68-
18. 图片统一放在 `/images/` 目录下,并采用**绝对路径**引入:
69-
1. 截图统一采用 **PNG** 格式,命名为三位数字,如:`001.png`;
70-
2. 拍照统一采用 **JPEG** 格式,命名为不带前导零的数字,如:`1.jpg`;
85+
18. 图片统一放在 `/images/` 目录下,并采用**绝对路径**引入,命名应具有描述性,使用连字符分隔
86+
1. 截图统一采用 **PNG** 格式,命名为三位数字,如:`memory-layout-stack.png`
87+
2. 拍照统一采用 **JPEG** 格式,命名为不带前导零的数字,如:`keyboard-layout.jpg`
7188
19. 在每篇文档结尾写出引用内容的出处;
7289
20. 语言风格:
7390
1. 使用正式的中文白话,不用口头语;
@@ -136,11 +153,20 @@ int main(int argc, char* argv[]){
136153

137154
1. 独立思考;
138155
2. 勤于搜索(尤其是出现较多关联概念时);
139-
3. 理解中文白话,最好有一定的英语水平(建议达到 CEFR B2),最好有一定的数学水平(高中数学 + 数理逻辑基础 + 微积分 + 基础的概率论 + 基础的数论 + 基础的图论)。
156+
3. 理解中文白话,最好有一定的英语水平(建议达到 CEFR B2);
157+
4. 针对数据结构与算法:最好有一定的数学水平(高中数学 + 数理逻辑基础 + 微积分 + 基础的概率论 + 基础的数论 + 基础的图论)。
140158

141159
## 许可证
142160

143-
[**CC-BY-NC-SA 4.0**](/LICENSE)
161+
本作品采用 [**CC BY-NC-SA 4.0**](/LICENSE) 许可协议。
162+
163+
[![CC BY-NC-SA 4.0](https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png)](http://creativecommons.org/licenses/by-nc-sa/4.0/)
164+
165+
转载或引用请遵守以下规则:
166+
167+
1. **署名**:请注明作者及原文链接。
168+
2. **非商业**:不得用于任何商业用途。
169+
3. **共享**:如果您修改了本文内容,必须以相同的许可协议发布。
144170

145171
## 参考资料
146172

docs/杂项/组件展示.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,6 @@ if (grade >= 90) {
117117

118118
</TerminalWindow>
119119

120-
------
121120
## Flyout/Term/Tips 悬浮提示框
122121

123122
<br/>

0 commit comments

Comments
 (0)