Skip to content

Commit 016c192

Browse files
committed
docs(readme): 优化文档结构并补充项目说明
- 增加项目徽章,展示构建与自动化状态 - 补充项目简介,突出内容特色与目标 - 新增“内容特色”和“如何阅读”章节,便于新手快速上手 - 优化参与贡献流程说明,统一术语与格式 - 明确开发命令,提升开发者体验
1 parent f19ab6b commit 016c192

File tree

1 file changed

+40
-13
lines changed

1 file changed

+40
-13
lines changed

README.md

Lines changed: 40 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,58 @@
11
# Zig 语言圣经
22

3+
[![autocorrect](https://github.com/zigcc/zig-course/actions/workflows/autocorrect.yml/badge.svg)](https://github.com/zigcc/zig-course/actions/workflows/autocorrect.yml)
4+
[![build](https://github.com/zigcc/zig-course/actions/workflows/build.yml/badge.svg)](https://github.com/zigcc/zig-course/actions/workflows/build.yml)
5+
[![check](https://github.com/zigcc/zig-course/actions/workflows/check.yml/badge.svg)](https://github.com/zigcc/zig-course/actions/workflows/check.yml)
6+
[![deploy](https://github.com/zigcc/zig-course/actions/workflows/deploy.yml/badge.svg)](https://github.com/zigcc/zig-course/actions/workflows/deploy.yml)
7+
[![pdf](https://github.com/zigcc/zig-course/actions/workflows/pdf.yml/badge.svg)](https://github.com/zigcc/zig-course/actions/workflows/pdf.yml)
8+
39
> Zig is a general-purpose programming language and toolchain for maintaining robust, optimal and reusable software.
410
>
511
> Zig 是一种通用的编程语言和工具链,用于维护健壮、最优和可重用的软件
612
713
![Cover Image](./course/public/cover_image.png "Cover Image")
814

9-
## 参与贡献
15+
**Zig 语言圣经** 是一份开源的 Zig 语言综合教程,旨在为中文 Zig 爱好者提供一份高质量的学习资源,内容涵盖从基础语法到高级特性的方方面面。
1016

11-
欢迎各位志同道合的“道友”参与贡献本文档,并一起壮大 zig 中文社区!
17+
## ✨ 内容特色
18+
19+
本教程覆盖了 Zig 学习和实践中的多个重要领域:
20+
21+
- **环境配置**: 指导如何安装和配置 Zig 开发环境。
22+
- **基础入门**: 包括变量、类型、流程控制、错误处理等基础知识。
23+
- **高级主题**: 深入探讨 `comptime`、异步、内存管理、C 语言交互等高级特性。
24+
- **工程实践**: 涵盖构建系统、包管理、单元测试和代码风格指南。
25+
- **版本示例**: 提供与 Zig 不同版本相对应的代码示例。
26+
27+
## 🚀 如何阅读
28+
29+
本项目使用 VitePress 构建。您可以直接在本地启动开发服务器以阅读最新内容:
1230

13-
本仓库使用的文档工具是 vitepress,建议了解一下 [vitepress 的 markdown 扩展](https://vitepress.dev/zh/guide/markdown)
31+
```sh
32+
bun i # 安装依赖
33+
bun dev # 启动热更开发服务
34+
```
35+
36+
## 🤝 参与贡献
37+
38+
欢迎各位志同道合的“道友”参与贡献本文档,并一起壮大 zig 中文社区!
1439

1540
贡献方法:
1641

17-
- fork 本文档仓库
42+
- Fork 本文档仓库
1843
- 创建一个新的分支,请勿直接使用主分支进行修改
19-
- 发起 pull request
20-
- 等待 review
21-
- 合并到上游仓库,并由 github action 自动构建
44+
- 发起 Pull Request
45+
- 等待 Review
46+
- 合并到上游仓库,并由 GitHub Action 自动构建
47+
48+
**开发命令:**
2249

2350
```sh
24-
bun i // 安装依赖
25-
bun dev // 启动热更开发服务
26-
bun format // 运行 prettier, zig fmt 和 autocorrect 格式化程序
27-
bun run build // 构建产物
28-
bun run preview // 运行预览
51+
bun i # 安装依赖
52+
bun dev # 启动热更开发服务
53+
bun format # 运行 prettier, zig fmt 和 autocorrect 格式化程序
54+
bun run build # 构建产物
55+
bun run preview # 运行预览
2956
```
3057

3158
> [!NOTE]
@@ -34,4 +61,4 @@ bun run preview // 运行预览
3461
> [!NOTE]
3562
> 本文档所使用的构建工具为 [bunjs](https://bun.sh/),在提交时请勿将其他 nodejs 的包管理工具的额外配置文件添加到仓库中。
3663
37-
> 如需要更新依赖,请参照此处 [Lockfile](https://bun.sh/docs/install/lockfile) 先设置 git 使用 bun 来 diff 文件!
64+
> 如需要更新依赖,请参照此处 [Lockfile](https://bun.sh/docs/install/lockfile) 先设置 git 使用 bun 来 diff 文件!

0 commit comments

Comments
 (0)