Update README.md

RM2PT · Sep 23, 2024 · da1662f · da1662f
1 parent 8e642ac
commit da1662f
Show file tree

Hide file tree

Showing 20 changed files with 84 additions and 22,232 deletions.
diff --git a/CaseStudies/HealthLife/.gitattributes b/CaseStudies/HealthLife/.gitattributes
diff --git a/CaseStudies/HealthLife/.project b/CaseStudies/HealthLife/.project
diff --git a/CaseStudies/HealthLife/HealthLife.aird b/CaseStudies/HealthLife/HealthLife.aird
diff --git a/CaseStudies/HealthLife/HealthLife.arkuimodel b/CaseStudies/HealthLife/HealthLife.arkuimodel
diff --git a/CaseStudies/SmartHome/.gitattributes b/CaseStudies/SmartHome/.gitattributes
diff --git a/CaseStudies/SmartHome/.project b/CaseStudies/SmartHome/.project
diff --git a/CaseStudies/SmartHome/SmartHome.aird b/CaseStudies/SmartHome/SmartHome.aird
diff --git a/CaseStudies/SmartHome/SmartHome.arkuimodel b/CaseStudies/SmartHome/SmartHome.arkuimodel
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Yilong Yang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.assets/picture1.png b/README.assets/picture1.png
diff --git a/README.assets/picture10.png b/README.assets/picture10.png
diff --git a/README.assets/picture2.png b/README.assets/picture2.png
diff --git a/README.assets/picture3.png b/README.assets/picture3.png
diff --git a/README.assets/picture4.png b/README.assets/picture4.png
diff --git a/README.assets/picture5.png b/README.assets/picture5.png
diff --git a/README.assets/picture6.png b/README.assets/picture6.png
diff --git a/README.assets/picture7.png b/README.assets/picture7.png
diff --git a/README.assets/picture8.png b/README.assets/picture8.png
diff --git a/README.assets/picture9.png b/README.assets/picture9.png
diff --git a/README.md b/README.md
@@ -0,0 +1,63 @@
+# AutoArk
+
+AutoArk 是针对鸿蒙生态体系，基于用户友好的鸿蒙应用 GUI 元模型与图形建模语言 [ArkDSL](https://github.com/RM2PT/ArkDSL)，实现的从 GUI 模型到高成熟度前端代码的自动生成方法，以帮助华为开发自主可控的低代码 GUI 生成技术与平台，进一步推进鸿蒙生态系统的发展。借助 ArkDSL 构建的鸿蒙应用模型可以通过 AutoArk 自动转换为鸿蒙应用的 ArkUI 代码，从而帮助新接触鸿蒙应用开发环境的用户在并不了解鸿蒙应用的架构和开发方式的情况下，能够借助已有的 GUI 开发经验，快速上手鸿蒙 GUI 的设计与开发，在降低学习门槛的同时提高鸿蒙应用的开发效率。ArkDSL 的元模型从项目结构、页面结构和逻辑结构三个部分描述一个 GUI 项目，其表达能力覆盖了鸿蒙 GUI 应用的基础信息，包括元素、布局、动画、逻辑、状态等信息。
+
+#### 项目结构视图
+
+<img src="./README.assets/picture1.png" width="500px">
+
+#### 页面结构视图
+
+<img src="./README.assets/picture2.png" width="500px">
+
+#### 逻辑结构视图
+
+<img src="./README.assets/picture3.png" width="500px">
+
+## 插件安装
+
+AutoArk 目前以 Eclipse 插件的形式安装，依赖于 Eclipse 2022-12。用户可以按照以下步骤安装 ArkDSL 插件包。
+
+1. 选择 Eclipse 顶部工具栏的 `Help > Install New Software...` 选项；
+
+2. 在弹出的窗口中选择 `Add...`，再选择 `Archive...` 选项，接着选中本地的 AutoArk 插件包；
+
+<img src="./README.assets/picture4.png" width="500px">
+
+3. 勾选 `RM2PT Generator - AutoArk`，取消勾选 `Contact all update sites during install to find required software`；
+
+<img src="./README.assets/picture5.png" width="500px">
+
+4. 在下一个窗口选择 `Next >`；
+
+<img src="./README.assets/picture6.png" width="500px">
+
+5. 随后接受许可协议条款，选择 `Finish`；
+
+<img src="./README.assets/picture7.png" width="500px">
+
+6. 在新弹出的窗口选择 `Select All`，接着 `Trust Selected`，随后重启 Eclipse 以完成 AutoArk 插件安装。
+
+<img src="./README.assets/picture8.png" width="500px">
+
+## 源码编译
+
+开发者可以在根目录下执行 `mvn clean package` 以编译项目，随后可以在 `AutoArk\com.rm2pt.generator.autoark.updatesite\target` 路径下找到编译好的 `com.rm2pt.generator.autoark.updatesite-X.X.X.zip` 插件包。
+
+## 模型构建
+
+利用 ArkDSL 构建鸿蒙应用 GUI 元模型的方法可以参考 [ArkDSL](https://github.com/RM2PT/ArkDSL) 插件安装。
+
+## 生成代码
+
+1. 右键 ArkDSL 项目内的 arkuimodel 文件，在右键菜单中选择 `ArkUI > Generate ArkUI Project` 选项，随后在弹出窗口中配置生成项目的名称和位置；
+
+<img src="./README.assets/picture9.png" width="500px">
+
+2. 在 `Next >` 页面可以配置项目的后端地址和鸿蒙 API 版本，最后 `Finish` 即可。
+
+<img src="./README.assets/picture10.png" width="500px">
+
+## 开源许可
+
+本项目使用 MIT 许可协议，详见 [LICENSE](./LICENSE) 文件。