doc: update readme

Author: ChinaIceF

README.md

@@ -13,24 +13,55 @@
 </p>
 
 ## Install
-Download this repository and run setup.py in cmd line:
+Clone this repository and run the following command in your terminal:
+
 ```cmd
 python setup.py install
 ```
-Due to the fact that this project is still in the development stage, it is temporarily not available on PyPi.
-
-However, we are currently working hard on it and will be available soon.
 
+> ⚠️ This project is still under active development. It is **not yet available on PyPi**, but will be in the future.
 
-## Run Examples
-Run `examples/Gallery for siui/start.py` to take a look at widgets and components of PyQt-SiliconUI
 
-To quick start, run:
-```cmd
-cd "examples/Gallery for siui"
-start start.py
+## Run the Example Gallery
+To explore the widgets, components, and framework offered by PyQt-SiliconUI, run 
+```
+examples/Gallery for siui/start.py
 ```
-Other more detailed examples for widgets are coming soon.
+
+### Refactoring Plan
+
+The refactoring of widgets is nearing completion. You can try them on the "Refactored Widgets" page in the Gallery.
+
+**Please note**:  
+If you plan to start a project using PyQt-SiliconUI in the near future, it is **highly recommended to use only the widgets listed under “Refactored Widgets”**.  
+The older widgets have many issues and are being gradually replaced.  
+
+Similarly, the application templates are also under a complete overhaul. Work on them will begin once the core widget and component refactors are done.  
+Since the current templates contain many flaws and have poor implementations,  
+**we strongly advise against using the old application templates for real-world projects until the refactor is complete**.
+
+### Refactored Modules Overview
+
+Below are actively maintained modules. Once these are fully implemented, outdated ones will be removed from the repository.
+
+#### Widgets
+
+- siui/components/button.py – Refactored button widgets  
+- siui/components/container.py – Refactored containers managed using Qt’s layout system  
+- siui/components/editor.py – Refactored input/edit widgets  
+- siui/components/graphic.py – Proxy widgets, wrappers, and graphic-related utilities  
+- siui/components/label.py – Widgets for displaying text and images, plus uncategorized ones  
+- siui/components/layout.py – New implementations of flow and waterfall layouts, also using Qt layouts  
+- siui/components/menu_.py – Menu components  
+- siui/components/popover.py – Popover-style widgets such as date pickers and time pickers  
+- siui/components/progress_bar_.py – Refactored progress bar widgets  
+- siui/components/slider_.py – Refactored sliders, including horizontal sliders and scrollbar handles  
+
+#### Core Features
+
+- siui/core/animation.py – Refactored animation utilities  
+- siui/core/event_filter.py – Various event filters  
+- siui/core/painter.py – Core drawing-related functions  
 
 
 ## See Also
@@ -41,4 +72,4 @@ Here are some project that created based on PyQt-SiliconUI:
 ## License
 PyQt-SiliconUI is licensed under [GPLv3](LICENSE) 
 
-Copyright © 2024 by ChinaIceF.
+Copyright © 2024-2025 by ChinaIceF.

docs/README_zh.md

@@ -23,12 +23,31 @@ python setup.py install
 ## 运行示例程序
 运行 `examples/Gallery for siui/start.py` 来体验 PyQt-SiliconUI 提供的控件、组件和框架
 
-也可直接在项目目录下运行以下命令:
-```cmd
-cd "examples/Gallery for siui"
-start start.py
-```
-其他针对各类控件的详细实例将逐一编写
+### 重构计划
+控件的重构即将完成。你可以在 Gallery 的 “重构控件” 页面试用。
+
+ **请注意**，如果您近期想尝试 PyQt-SiliconUI 编写项目，**非常不推荐您使用除了 “重构控件” 以外的控件**。旧控件包含大量缺陷，正在逐步被重构控件取代。另外，应用模版也在重构计划内。将会在控件、组件的重构基本完成后着手实现。由于旧的应用模板存在大量的代码漏洞，功能的实现也非常丑陋，
+**在应用模版重构完成前，不建议您正式使用 PyQt-SiliconUI 的应用模版搭建项目**
+
+### 重构模块内容解释
+以下列出了一些正在积极维护的模块。完全完成这些模块的实现后，将从仓库中移除旧的模块 / 包。
+
+#### 控件
+- `siui/components/button.py` 包含了重构的按钮控件
+- `siui/components/container.py` 包含了重构的容器。新的容器全部采用 Qt 的 Layout 系统进行管理。
+- `siui/components/container.py` 包含了重构的编辑框控件
+- `siui/components/graphic.py` 包含图形代理控件，包装器等与图形代理相关的控件和功能
+- `siui/components/label.py` 包含以展示简单文本和图像为功能的控件，以及一些暂未归类的控件
+- `siui/components/layout.py` 包含流式布局，瀑布流布局的新实现。与重构的容器一样采用 Layout 系统进行管理
+- `siui/components/menu_.py` 包含菜单组件
+- `siui/components/popover.py` 包含一些 popover 类窗口的实现，例如日期选择器，时间选择器等
+- `siui/components/progress_bar_.py` 包含重构的进度条控件
+- `siui/components/slider_.py` 包含重构的滑块。例如水平滑块，滚动区域的滑块等
+
+#### 功能
+- `siui/core/animation.py` 包含重构的动画
+- `siui/core/event_filter.py` 包含各种事件过滤器
+- `siui/core/painter.py` 包含绘制相关功能的实现
 
 
 ## 另请参阅
@@ -39,7 +58,7 @@ start start.py
 ## 许可证
 PyQt-SiliconUI 使用 [GPLv3](../LICENSE) 许可证
 
-版权所有 © 2024 by ChinaIceF.
+版权所有 © 2024-2025 by ChinaIceF.
 
 
 ## 特别声明