Skip to content

Commit 4973246

Browse files
authored
Merge pull request #25 from EgoSay/docs/mdbook-usuage
docs: update mdbook usuage
2 parents c31d87d + 0d1cb6f commit 4973246

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

README.md

+24-3
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,36 @@
44

55
可以通过此链接访问官方 wiki [Protocol Studies Wiki](https://epf.wiki/#/README?id=protocol-wiki)
66

7-
## 协议学习 Wiki (Protocol Studies Wiki)
8-
9-
您可以直接访问翻译后的 Wiki,学习以太坊协议的技术细节和核心原理:
7+
## How to use
8+
9+
### 本地编译
10+
1. download first
11+
```bash
12+
git clone [email protected]:YoubetDao/epf-protocol-cn.git
13+
```
14+
2. 基于 `mdbook` 工具本地启动服务查看效果
15+
```bash
16+
cd epf-protocol-cn
17+
mdbook serve
18+
```
19+
![mdbook](https://3bcaf57.webp.li/myblog/mdbook1.png)
20+
21+
注: `mdbook` 是基于 Rust 的一个使用`Markdown` 创建图书的命令行工具, 需要本地先安装命令, 详情参考官方文档: [mdbook](https://rust-lang.github.io/mdBook/)
22+
```bash
23+
cargo install mdbook
24+
```
25+
### 线上阅读
26+
或者您也可以直接访问翻译后的 Wiki,学习以太坊协议的技术细节和核心原理:
1027

1128
- [中文 Wiki 地址](https://youbetdao.github.io/epf-protocol-cn/)
1229
- 或前往 `/src` 查看翻译源文件。
1330

31+
32+
1433
欢迎加入我们,探索以太坊协议并参与贡献!
1534

35+
36+
1637
- **Telegram 社区**[加入讨论](https://t.me/+_a-io1KqMIc5ZjQ9)
1738

1839
## 如何参与?

0 commit comments

Comments
 (0)