diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..695e48e --- /dev/null +++ b/README.en.md @@ -0,0 +1,20 @@ +# kLoop + +kLoop is an implementation of the Python +[asyncio](https://docs.python.org/3/library/asyncio.html) event loop written +in [Cython](https://cython.org/), using +[io_uring](https://unixism.net/loti/what_is_io_uring.html) and +[kTLS](https://www.kernel.org/doc/html/latest/networking/tls-offload.html) +features of the Linux kernel, therefore called k(ernel)Loop. + +kLoop is open-sourced and released under the +[MulanPSL - 2.0 license](http://license.coscl.org.cn/MulanPSL2). + +**⚠️WARNING: THIS PROJECT IS IN PROOF-OF-CONCEPT STAGE!⚠️** + + +## Requirements + +* Python >= 3.8 +* Linux >= 5.11 (enable kTLS with `modprobe ktls`) +* OpenSSL >= 3.0 diff --git a/README.md b/README.md index bee23df..ac27f3e 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,22 @@ # kLoop -kLoop is an implementation of the Python -[asyncio](https://docs.python.org/3/library/asyncio.html) event loop written -in [Cython](https://cython.org/), using -[io_uring](https://unixism.net/loti/what_is_io_uring.html) and +[English](README.en.md) + +kLoop 是一个 Python +[asyncio](https://docs.python.org/3/library/asyncio.html) event loop 的实现, +主要用 [Cython](https://cython.org/) 编写,重点使用了 Linux 内核的 +[io_uring](https://unixism.net/loti/what_is_io_uring.html) 和 [kTLS](https://www.kernel.org/doc/html/latest/networking/tls-offload.html) -features of the Linux kernel, open-sourced and released -under the [MulanPSL - 2.0 license](http://license.coscl.org.cn/MulanPSL2). +功能,故称作 k(ernel)Loop。 -**⚠️WARNING: THIS PROJECT IS IN PROOF-OF-CONCEPT STAGE!⚠️** +您可在[木兰宽松许可证, 第2版](http://license.coscl.org.cn/MulanPSL2)的范围内使用 +kLoop 的源代码。 + +**⚠️警告:项目仍在概念验证当中,满地都是坑!⚠️** -## Requirements +## 环境需求 * Python >= 3.8 -* Linux >= 5.11 (enable ktls with `modprobe ktls`) -* OpenSSL 1.1.1 (3.0 is unnecessary) - +* Linux >= 5.11 (用 `modprobe ktls` 命令来启用 kTLS 模块) +* OpenSSL >= 3.0 diff --git a/setup.cfg b/setup.cfg index 3053ae1..d58a244 100644 --- a/setup.cfg +++ b/setup.cfg @@ -4,7 +4,7 @@ version = 0.0.1 author = Fantix King author_email = fantix.king@gmail.com description = An asyncio event loop using Linux io_uring and kTLS. -long_description = file: README.md +long_description = file: README.en.md long_description_content_type = text/markdown url = https://github.com/fantix/kloop project_urls =