From 112d2514b165d9511c487a24326d00982ed1e712 Mon Sep 17 00:00:00 2001
From: cxykevin <cxykevin@yeah.net>
Date: Fri, 19 Apr 2024 21:51:54 +0800
Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0rst=E6=96=87=E4=BB=B6=20for?=
 =?UTF-8?q?=20pypi?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.rst | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 setup.py   |  2 +-
 2 files changed, 75 insertions(+), 1 deletion(-)
 create mode 100644 README.rst

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..99297e1
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,74 @@
+.. |icon| image:: http://git.hmtsai.cn/cxykevin/magictk-img-readme/raw/branch/master/icon.ico
+
+magictk
+--------
+
+一个模仿 `element plus <https://element-plus.org/>`__ 的 tkinter 组件库
+
+Warning
+--------
+Rst File is not the latest version!
+Please look the markdown edition
+
+演示
+----
+
+.. raw:: html
+
+   <video width="420" height="240" controls src="/cxykevin/magictk-img-readme/raw/branch/master/2024-04-05_show.mp4">
+您的浏览器不支持使用 HTML5 ‘video’ 标签。
+   </video>
+
+依赖
+----
+
+-  ``pywin32`` (Only in ``Windows``)
+
+性能
+----
+
+   | 测试机器：
+   | - Arch Linux x86_64
+   | - Wayland + KDE Plasma
+   | - Intel Celeron G1840 (2) @  ``2.800GHz``
+   | - Intel HD Graphics
+   | - Memory: ``11665MiB``
+   | - htop
+
+CPU 占用： - 单窗口约 ``20%``
+
+   非最新数据
+
+Memory 占用： - 约 ``50 MiB``
+
+   性能测试会消耗 ``200`` MiB 内存, Tim Sort ``sort()`` 1e7 随机数据
+   测试
+
+组件
+----
+
+   以下组件按完成时间从上(早)到下(晚)排序
+
+1. ``Window``
+
+   在 Linux下存在强制置顶问题，且最大化存在问题 OSX 未经过测试
+2. ``Button``
+3. ``ProgressBar``
+4. ``CheckBox`` (``Radio``)
+
+   ``Radio`` 可以使用``Checkbox`` 指定 ``RadioGroup`` 实现
+5. ``Menu``
+6. ``Select``
+7. ``Frame``
+
+   所有组件必须配合自定义的 ``Frame`` 使用，因为 ``Frame`` 携带 ``root`` 信息(可手动指定)
+8. ``Input``
+
+   在 ``Linux`` 下会弹出一个空窗口
+   (如果没有这个窗口无法输入，原理尚不清楚)
+   
+以下为计划开发顺序： 
+--------------------
+
+9. ``ScrollBar``
+
diff --git a/setup.py b/setup.py
index e389122..178750c 100644
--- a/setup.py
+++ b/setup.py
@@ -16,7 +16,7 @@ else:
 
 print("BUILD: version="+set_v)
 
-with open("README.md", "r", encoding='utf-8') as file:
+with open("README.rst", "r", encoding='utf-8') as file:
     long_desp = file.read()
 
 print("----- setup -----")