Skip to content

Commit 885606f

Browse files
committed
精简 README,改用 make 引导本地运行并移除 roadmap
roadmap 改在站点首页维护,README 仅保留简介、在线版链接与 make 命令
1 parent 81df874 commit 885606f

1 file changed

Lines changed: 9 additions & 64 deletions

File tree

README.md

Lines changed: 9 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,20 @@
1-
# 介绍
1+
# Python 3 源码分析
22

33
本项目致力于对 Python 3.7 的源码分析,深度参考陈儒大大的《Python 源码剖析》,编写 Python 3 的版本。
44

55
希望各位 Python 爱好者能参与其中,一起探索 Python 魔法背后的奥秘!
66

7-
# 使用
7+
## 阅读
88

9-
您可以直接访问 [在线版](https://flaggo.github.io/python3-source-code-analysis/),或者根据以下步骤访问本地版
9+
直接访问 [在线版](https://flaggo.github.io/python3-source-code-analysis/) 即可阅读全书
1010

11-
本项目使用 [VitePress](https://vitepress.dev/) 构建。
11+
## 本地运行
1212

13-
## 前置条件
14-
15-
您的系统上需要安装好 Node.js 18 及以上版本(会自带 npm)。
16-
17-
## 安装依赖
13+
本项目使用 [VitePress](https://vitepress.dev/) 构建。直接运行 `make` 可查看所有命令:
1814

1915
```console
20-
npm install
16+
make install # 安装依赖
17+
make serve # 启动本地预览,访问 http://localhost:5173/python3-source-code-analysis/
18+
make build # 构建静态页面到 .vitepress/dist
19+
make clean # 删除构建产物
2120
```
22-
23-
## 本地预览
24-
25-
启动本地开发服务器(支持热更新):
26-
27-
```console
28-
npm run dev
29-
```
30-
31-
然后访问 http://localhost:5173/python3-source-code-analysis/ 即可查看本书内容。
32-
33-
> 也可以使用 `make serve`,等价于 `npm run dev`
34-
35-
## 构建静态页面
36-
37-
```console
38-
npm run build
39-
```
40-
41-
构建产物输出到 `.vitepress/dist`,可用如下命令在本地预览构建结果:
42-
43-
```console
44-
npm run preview
45-
```
46-
47-
# Roadmap
48-
49-
大体按照《Python 源码剖析》中的目录结构进行编写。依次介绍 Python 源码基本信息、内建对象和虚拟机。
50-
51-
- [x] 章节
52-
- [x] 序章
53-
- [x] 前言
54-
- [x] Python 源代码的组织
55-
- [x] Windows 环境下编译 Python
56-
- [x] UNIX/Linux 环境下编译 Python
57-
- [x] 修改 Python 源码
58-
- [ ] Python 内建对象
59-
- [x] Python 对象初探
60-
- [x] Python 整数对象
61-
- [ ] Python 字符串 对象
62-
- [x] Python List 对象
63-
- [x] Python Dict 对象
64-
- [x] Python Set 对象
65-
- [ ] Python 虚拟机
66-
- [ ] Python 编译结果
67-
- [ ] Python 虚拟机框架
68-
- [ ] 虚拟机一般表达式
69-
- [ ] Python 虚拟机控制流
70-
- [ ] Python 虚拟机函数机制
71-
- [ ] Python 运行环境初始化
72-
- [ ] Python 模块加载机制
73-
- [ ] Python 多线程机制
74-
- [ ] Python 内存管理机制
75-

0 commit comments

Comments
 (0)