diff --git a/README.md b/README.md index b6ca6fa..781fc03 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,56 @@ -# multimedia_image_effect - -#### ImageEffect框架 -- ImageEffect框架 -#### 软件架构 -软件架构说明 +# ImageEffect + +- [Introduction](#Introduction) + - [Basic Concepts](#Basic-Concepts) +- [Directory Structure](#Directory-Structure) +- [Compilation](#Compilation) +- [Repositories Involved](#Repositories-Involved) + - [Filter Chain Processing](#Filter-Chain-Processing) + - [Single Filter Processing](#Single-Filter-Processing) + - [Custom Filter Processing](#Custom-Filter-Processing) + +## Introduction + -#### 安装教程 +**Image** 1 Diagram of the image editing component architecture -1. xxxx -2. xxxx -3. xxxx - -#### 使用说明 - -1. xxxx -2. xxxx -3. xxxx - -#### 参与贡献 - -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request +![](figures/imageeffect-architecture.jpg) -#### 特技 +## Directory Structure -1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +The structure of the repository directory is as follows: + +``` +/foundation/multimedia/image_effect +├── frameworks +│ ├── native +│ │ └── capi +│ │ ├── effect +│ │ └── efilter +│ │ └── utils +├── interfaces +│ ├── inner_api +│ └── kits +├── test +│ └── unittest +├── BUILD.gn +├── bundle.json +├── config.gni +└── LICENSE +``` + +## Compilation + +``` +./build.sh --product-name {product-name} --build-target foundation/multimedia/image_effect:image_effect +``` + + {product-name} is the currently supported platform, such as rk3568. + +## Repositories Involved + +[ImageEffect Development Guidance (C/C++)](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/media/image/image-effect-guidelines.md)。 diff --git a/figures/imageeffect-architecture.jpg b/figures/imageeffect-architecture.jpg index 9775940..cc739f6 100644 Binary files a/figures/imageeffect-architecture.jpg and b/figures/imageeffect-architecture.jpg differ