diff --git a/README.md b/README.md index 750df0088a2a96e0eb1e7b308d53ef6ebfe6d537..493df210aeef139b7e36a64ed98dab9ac67227d6 100644 --- a/README.md +++ b/README.md @@ -1,77 +1,73 @@ # CalendarData -## 1. Introduction +## Introduction -The calendardata application is a preset application in OpenHarmony that provides the function of adding, deleting, modifying, and checking the schedule +CalendarData is a preset application in OpenHarmony. It allows users to add, delete, modify, and query calendars. -## 2. Directory Structure +## Directory Structure ``` ├─AppScope │ │ -│ └─resources # resource file +│ └─resources # Resource files ├─common │ │ │ └─src │ └─main -│ └─ets # basic methods +│ └─ets # Common methods ├─datamanager │ └─src │ └─main -│ └─ets # data manager +│ └─ets # Data manager ├─dataprovider │ └─src │ └─main -│ └─ets # the proxy of data manager +│ └─ets # Data manager proxy ├─datastructure │ └─src │ └─main -│ └─ets # data structure +│ └─ets # Data structure ├─entry │ └─src -│ └─main # the entry of project +│ └─main # Application entry ├─rrule │ └─src │ └─main -│ └─ets # recurrence rule -└─signature # certificate file +│ └─ets # Recurrence rule +└─signature # Certificate file ``` ### Architecture ![](./figures/architecture.png) -- **product** - Business form layer: Distinguish various forms of applications for different products and screens, including personalized business, component configuration, and personalized resource packages。 +As a built-in basic application, Calendar implements basic user operations such as querying daily and monthly views and creating and querying calendars. The Calendar APIs provide SQL-free, object-based data read and write capabilities. CalendarData manages calendars, reminders, and data. -- **feature** - Common feature layer: An abstract collection of common feature components that can be referenced by various application forms。 +## How to Use -- **common** - Common capability layer: Basic capability set, modules that each application form must rely on, including tool classes and common resource packages。 - -## 3. Packaging - -Open project engineering by DevEco Studio, choose: Build → Build Haps(s)/APP(s) → Build Hap(s) +Open a project in DevEco Studio and choose **Build > Build Haps(s)/APP(s) > Build Hap(s)**. ![](./figures/build_haps.png) -After compilation, the HAP package will be generated in the `\build\outputs` path in the project directory (if no signature is configured, only unsigned HAP packages will be generated) +After the build is complete, a HAP file is generated in **\build\outputs** in the project directory. (If no signature is configured, an unsigned HAP file is generated.) ![](./figures/build_output_dir_release.png) -### Install - -Install the compiled hap package using the command: hdc_std install "HAP packet address" +Run the **hdc_std install "*hap package address*"** command to install the compiled HAP file. ![](./figures/calendar_install.png) -## Constraint -- Development Environment - - **DevEco Studio for OpenHarmony**: Version number greater than 3.1.1.101, Download and Install OpenHarmony SDK API Version 10(The initial IDE configuration can refer to the IDE usage documentation) -- Language - - ArkTS -- Limitation - - This example only supports running on standard systems - - - +## Constraints +- Development environments + - DevEco Studio for OpenHarmony: version later than 3.1.1.101 + + - OpenHarmony SDK: API version 10 + + For details about the initial DevEco Studio configuration, see the DevEco Studio usage document. + +- Programming language + + ArkTS + +- Limitations + + This application can only be run on standard-system devices. diff --git a/README_zh.md b/README_zh.md index 0ba3b1b283ace676f6da35eb28eff421591e219f..2b4796f52c35be67ff9d8a48853463a2410d7831 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,10 +1,10 @@ # 日历存储应用 -## 1. 项目介绍 +## 项目介绍 -日历存储应用是OpenHarmony中预置的应用,提供日程的增删改查功能 +日历存储应用是OpenHarmony中预置的应用,提供日程的增删改查功能。 -## 2. 目录结构 +## 目录结构 ``` ├─AppScope │ │ @@ -40,28 +40,19 @@ ![](./figures/architecture.png) -- **product** - 业务形态层:区分不同产品、不同屏幕的各形态应用,含有个性化业务,组件的配置,以及个性化资源包。 - -- **feature** - 公共特性层:抽象的公共特性组件集合,可以被各应用形态引用。 - -- **common** - 公共能力层:基础能力集,每个应用形态都必须依赖的模块,包含工具类和通用的资源包 +Calendar作为内建基础应用,实现日月视图查看、日程创建查看等与用户交互相关的基础操作;Calendar API提供免SQL的对象化数据读写访问能力;CalendarData负责日程管理、提醒管理以及数据管理等功能。 -## 3. 打包 +## 使用说明 -在DevEco Studio打开项目工程,选择Build → Build Haps(s)/APP(s) → Build Hap(s) +在DevEco Studio打开项目工程,选择Build → Build Haps(s)/APP(s) → Build Hap(s)。 ![](./figures/build_haps.png) -编译完成后,hap包会生成在工程目录下的 `\build\outputs`路径下(如果没有配置签名,则只会生成未签名的hap包) +编译完成后,hap包会生成在工程目录下的 `\build\outputs`路径下。(如果没有配置签名,则只会生成未签名的hap包) ![](./figures/build_output_dir_release.png) -### 安装 - -使用hdc_std install "hap包地址" 命令进行安装编译后的hap包 +使用hdc_std install "hap包地址" 命令进行安装编译后的hap包。 ![](./figures/calendar_install.png)