Skip to content

Commit 8d00eaf

Browse files
authored
Update README.md
1 parent 44e7997 commit 8d00eaf

File tree

1 file changed

+15
-18
lines changed

1 file changed

+15
-18
lines changed

README.md

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,18 @@ int main(int argc, char* argv[]){
1818
}
1919
```
2020
21-
1. 这里是 **Mdr's C Tutorial**,欢迎来这里共同学习
21+
1. 这里是 **Mdr's C Tutorial**,欢迎来这里共同学习
2222
2. 此仓库中文档的定位是**教程讲义**:
2323
对于贡献者,意味着无需引导和废话,只需讲干货;
24-
对于读者,意味着阅读这些文档可以快速获得与**C 语言**以及**计算机科学**相关知识
25-
3. 本教程以及本讲义的目标:在**准确**的基础上力争**简洁**和**生动**
26-
4. 此教程并非一时兴起而作,实则怀为往圣继绝学,为万世开太平之愿,深思熟虑打造而成
24+
对于读者,意味着阅读这些文档可以快速获得与**C 语言**以及**计算机科学**相关知识
25+
3. 本教程以及本讲义的目标:在**准确**的基础上力争**简洁**和**生动**
26+
4. 此教程并非一时兴起而作,实则怀为往圣继绝学,为万世开太平之愿,深思熟虑打造而成
2727
5. 得天独厚者,替天行善!
2828
29-
- 点此进入 [**总纲**](/docs/教程/正文/总纲.md);
30-
- 点此进入 [**关于本教程**](/About.md);
31-
- **文档规范**中列举了本仓库 markdown 文档的规范;
32-
- **代码规范**中列举了本仓库 C 语言代码的规范;
33-
- **对预期读者的要求**中列举了读者需要具备的一些前置知识;
34-
- **鸣谢名单**展示本仓库文档或代码的贡献者以及本教程的赞助者。
35-
3629
## 文档规范
3730
31+
该栏为本仓库 markdown 文档的规范。
32+
3833
1. 标题由**一级标题**开始,依次递减;
3934
2. 标题层级不应过多,如果出现该情况,可以拆分成多篇文章;
4035
一般地,标题层级不应超过**四**级;
@@ -52,27 +47,29 @@ int main(int argc, char* argv[]){
5247
11. 要正确使用标点符号,分清**顿号**、**逗号**、**分号**和**句号**,尤其避免一逗到底;
5348
12. 分清**的地得**和**他她它**
5449
13. 仅在必要时使用**数量词**(尤其警惕**一个**的不恰当使用)
55-
14. 在**术语** (Terminology) 首次出现的时候在**半角小括号** 内给出**对应的外来语**,同时给出**首字母缩略语** (Acronym)。这些外来语通常对应**概念** (Concept) 的原文 ,希望有助于读者明确分辨词语的含义:
50+
14. 在**术语** (Terminology) 首次出现的时候在**半角小括号**内给出**对应的外来语**,同时给出**首字母缩略语** (Acronym)。这些外来语通常对应**概念** (Concept) 的原文 ,希望有助于读者明确分辨词语的含义:
5651
1. 为减少读者的记忆负担,下文分情况使用**术语的汉语表述**和**首字母缩略语**:初始章节以前者为主,进阶章节以后者为主
5752
2. 外来语和缩略语可能视情况在不同章节多次出现
5853
3. 括号外左侧右侧各空一个空格,括号内无空格
5954
4. 外来语**不能**带斜体、加粗、下划线、删除线和代码块——用默认的字体;
6055
5. 大部分外来语单词摘自 [维基百科](https://zh.wikipedia.org) 和 [C++ 参考手册](https://en.cppreference.com/);
61-
15. **专有名词**需**大写**
56+
15. 专有名词需大写
6257
16. 图片统一放在 `/images/` 目录下,并采用**绝对路径**引入:
6358
1. 截图统一采用 **PNG** 格式,命名为三位数字,如:`001.png`;
6459
2. 拍照统一采用 **JPEG** 格式,命名为不带前导零的数字,如:`1.jpg`;
6560
17. 在每篇文档结尾写出引用内容的出处;
6661
18. 语言风格:
67-
1. 使用 **正式**的中文白话,**不用**口头语
68-
2. **杜绝语病**
69-
3. _尽量不用_ 反问,设问和借喻;
62+
1. 使用正式的中文白话,不用口头语
63+
2. 杜绝语病;
64+
3. 尽量不用反问,设问和借喻;
7065
4. 用清晰的修饰限定成分,避免含混不清;不用过于夸张的修饰限定成分;有数据支持时要列举数据;
7166
5. 避免带有主观性的措辞;避免连续的词表示相同意思;
72-
6. 保证仓库中所有文档**语言风格一致**
67+
6. 保证仓库中所有文档语言风格一致
7368
7469
## 代码规范
7570
71+
该栏为本仓库 C 语言代码的规范。
72+
7673
1. 如果是项目代码,需要构建系统完成编译运行,须将必要的相关文件放入对应目录,如 `CMakeLists.txt` 和 `xmake.lua` 等;
7774
2. 源文件后缀名为 `.c`,头文件后缀名为 `.h`;
7875
3. 代码需保证在新版 GCC 和 Clang 上以新版 C 语言标准编译通过,“语法和标准库”部分的代码还需做到开启 `-Wall` 和 `-Wextra` 无警告;
@@ -95,7 +92,7 @@ int main(int argc, char* argv[]){
9592

9693
1. 独立思考;
9794
2. 勤于搜索(尤其是出现较多关联概念时);
98-
3. 理解中文白话,最好有一定的英语水平(建议达到 CEFR B2)但不强制,最好有一定的数学水平(高中数学 + 数理逻辑基础 + 微积分 + 基础的概率论 + 基础的数论 + 基础的图论)但不强制;
95+
3. 理解中文白话,最好有一定的英语水平(建议达到 CEFR B2),最好有一定的数学水平(高中数学 + 数理逻辑基础 + 微积分 + 基础的概率论 + 基础的数论 + 基础的图论)
9996

10097
## 许可证
10198

0 commit comments

Comments
 (0)