diff --git a/MANIFEST.in b/MANIFEST.in index 6dbb028..c675e90 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,6 +1,6 @@ include README*.md include Makefile -include architecture.*.png +recursive-include docs *.png *.md recursive-include src *.pyx *.pxd *.h include resolver/Cargo.toml include resolver/Cargo.lock diff --git a/README.md b/README.md index 66726de..735879d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ -# kLoop +# kLoop - *asyncio on Linux kernel* -[中文](README.zh.md) +[![中文](https://img.shields.io/badge/Zh-中文-informational?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAQCAYAAAAWGF8bAAAAAXNSR0IArs4c6QAAAERlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAA6ABAAMAAAABAAEAAKACAAQAAAABAAAAFKADAAQAAAABAAAAEAAAAABHXVY9AAABc0lEQVQ4EaWSOy8EURTHd+wDEY94JVtgg9BI1B6dQqHiE1CrRasT30DpC2hVQimiFkJWVsSj2U1EsmQH4/ff3CO3WDuDk/zmf8/jnntm7qRSMRZFUQ4WYSimNFmaRlsgq8F83K6WuALyva4mixbc+kfJcGqa7CqU4AjaocNpG5oHsx7qB3EqQRC8K4g/gazAMbFTBdbgL1Zh0w2EbnMVHdMrd4LZNotZmIZJKMAemC2z0MS6oDlYhzOQ6c3yGR5Fec4OGPvEHCmn3np+kfyT51+QH8afcbFLTfjgFVS9tZrpwC4v1k9M39w3NTQrBxSM4127SAmNoBt0Ma3QyHRwGUIYdQUh0+c0wZsLPKKH8AwvoHgNlmABZLtwBdqnP0DD9IEG2If6N0oz5SbYSfW4PYhvgNmUxU1JZGEEAsUyjPmB7lhBA1Xe7NMWpuzXa39fnC7lN1b/mZttSNLQv9XXZs2US9LwzjU5R+/d+n/CBx9I2uELeXrRajeDqHwAAAAASUVORK5CYII=)](README.zh.md) +[![build](https://img.shields.io/github/workflow/status/fantix/kloop/构建?label=build&logo=github)](https://github.com/fantix/kloop/actions/workflows/build.yml) +[![downloads](https://img.shields.io/pypi/dm/kloop?logo=pypi&logoColor=white)](https://pypi.python.org/pypi/gino) +[![code quality](https://img.shields.io/codacy/grade/f2e97d6eb2554e87b3cd15aae8f6b1e0?logo=codacy)](https://app.codacy.com/gh/fantix/kloop/dashboard) +[![license](https://img.shields.io/badge/license-MulanPSL--2.0-success?logo=opensourceinitiative&logoColor=white)](http://license.coscl.org.cn/MulanPSL2/) kLoop is an implementation of the Python [asyncio](https://docs.python.org/3/library/asyncio.html) event loop written @@ -49,7 +53,7 @@ Development and testing is done on Ubuntu 22.04. ## Architecture Diagram -![architecture.png](architecture.en.png) +architecture.png Looks like the Lucky Charms factory, says @aaronbrighton ... diff --git a/README.zh.md b/README.zh.md index 3975e20..3c25a1d 100644 --- a/README.zh.md +++ b/README.zh.md @@ -1,6 +1,10 @@ -# kLoop +# kLoop：*Linux 内核上的 asyncio* -[English](README.md) +[![English](https://img.shields.io/badge/英文-English-informational?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABsAAAAQCAYAAADnEwSWAAAABGdBTUEAALGPC/xhBQAAADhlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAAqACAAQAAAABAAAAG6ADAAQAAAABAAAAEAAAAACiF0fSAAABJUlEQVQ4EWP8//8/MwMDAysQEw0YGRl/EK0YWSHQsgogJgX8RNZPCpuJFMWUqqWrZSw4XBsCFL+FQ+4/DnEUYWC8gNKCEDB+X8MlgIKVWCJMD64ADwOorwmIHyNhdyDbFYgPAfFXIAaBV0CcCTIG5DNsLo0GKnDEYc8+oGsvQ+UEgLQMkrpYIDsSiJGjRxTInwY07wmuYCxDMgCdmQUUgFmGLheNLoDEzwG5gBFJgFQmNr3ZQEPsgfgImmEquHy2BajwHZpiGPcmjAGk0aPgCDCIp4HkgcHWA6RsQGwoEMEVZ9VATZdgqkig7yKp/YjEBjORIxJdjhw+3tIFVzCGAoPBEo9ta4E+f4NHHqsULstqsKpGCJ4BMkm2jNrBiHAOFhZdLQMA8pKhkQYZiokAAAAASUVORK5CYII=)](README.md) +[![构建](https://img.shields.io/github/workflow/status/fantix/kloop/构建?label=构建&logo=github)](https://github.com/fantix/kloop/actions/workflows/build.yml) +[![下载](https://img.shields.io/pypi/dm/kloop?logo=pypi&logoColor=white&label=下载)](https://pypi.python.org/pypi/gino) +[![质量](https://img.shields.io/codacy/grade/f2e97d6eb2554e87b3cd15aae8f6b1e0?logo=codacy&label=质量)](https://app.codacy.com/gh/fantix/kloop/dashboard) +[![许可](https://img.shields.io/badge/许可-木兰PSLv2-success?logo=opensourceinitiative&logoColor=white)](http://license.coscl.org.cn/MulanPSL2/) kLoop 是一个 Python [asyncio](https://docs.python.org/3/library/asyncio.html) @@ -43,7 +47,7 @@ kLoop 的源代码或发行版。 ## 架构图 -![架构图.png](architecture.zh.png) +架构图.png @aaronbrighton 说像 Lucky Charms 卡通麦片工厂…… diff --git a/architecture.en.png b/architecture.en.png deleted file mode 100644 index e69de29..0000000 diff --git a/architecture.zh.png b/architecture.zh.png deleted file mode 100644 index e69de29..0000000 diff --git a/docs/architecture.en.png b/docs/architecture.en.png new file mode 100644 index 0000000..ad8fca5 Binary files /dev/null and b/docs/architecture.en.png differ diff --git a/docs/architecture.zh.png b/docs/architecture.zh.png new file mode 100644 index 0000000..50d91e0 Binary files /dev/null and b/docs/architecture.zh.png differ diff --git a/docs/kloop@2x.png b/docs/kloop@2x.png new file mode 100644 index 0000000..a52eafa Binary files /dev/null and b/docs/kloop@2x.png differ