Update doc, add index.md

caiyili · Dec 8, 2023 · b58f18b · b58f18b
1 parent a5cdb26
commit b58f18b
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -3,14 +3,13 @@ phpy
 `Python` 与 `PHP` 互调用库，可以在 `PHP` 中使用 `Python` 语言的函数和类库，或者在 `Python` 中使用 `PHP` 的包。
 但不是语言内嵌。编码依然使用各自的原生语法。
 
-> 本项目授权协议为 `Apache2`
+> 查看 [中文文档](docs/index.md)  
 
 - 目前仅支持 Linux 平台（理论上可以支持所有操作系统，待实现）
 - 不支持 Python 多线程、`async-io` 特性
 
 ![Alt](docs/wxg.png)
 
-
 PHP 调用 Python
 ----
 编译安装 `phpy.so` 作为扩展加载，修改 `php.ini` 追加 `extension=phpy.so` 即可。

diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,14 @@
+中文文档
+====
+
+- [简易教程](php/tutorial.md)
+- [开发路径](roadmap.md)
+
+PHP 扩展
+----
+* [编译安装](php/build.md)
+* [语言核心](php/core.md)
+* [内置类型](php/object.md)
+* [整型数字](php/int.md)
+* [回调函数](php/fn.md)
+* [性能测试](benchmark.md)
diff --git a/docs/roadmap.md b/docs/roadmap.md
@@ -1,5 +1,28 @@
 # 工作方向
+**phpy 是一个年轻的开源项目，有大量的工作需要热心的开源工作者去做，下面是贡献的几个方向，期待与您一起并肩工作。**
 
-1. 在 `PyCore` 增加更多的内置函数支持
+
+## 开发
+1. 在 `PyCore` 模块中增加更多功能函数支持
 2. 增加更多 `PyObject` 的子类，更精细的类型
 3. 子类增加更多的特殊方法
+
+## 测试
+- 增加 `PHPUnit` 单元测试，提高覆盖率
+- 增加 `pytest` 单元测试
+
+## 文档
+- 完善 PHP 文档
+- 完善 Python 文档
+- 编写英文文档
+
+## 实例
+- 增加更多例子程序
+
+## 工具
+- 自动生成 Python 模块类库，`tools/gen-lib.php`
+- 自动生成 PHP 类库
+
+
+
+