diff --git a/.README_ZH.md.swp b/.README_ZH.md.swp new file mode 100644 index 00000000..f75a21ca Binary files /dev/null and b/.README_ZH.md.swp differ diff --git a/README_ZH.md b/README_ZH.md index 86bccc39..0fbd02d0 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -23,17 +23,18 @@ │ └── README # 工具使用指导 ``` -##约束 +## 约束 系统:建议Ubuntu 20.04或者Windows 10 依赖版本:vscode 1.62.0 -##使用方法 +## 使用方法 工具支持三种入口,分别是可执行文件、VS插件、IntelliJ插件,使用方法如下: https://gitee.com/openharmony-sig/napi_generator/blob/master/docs/INSTRUCTION_ZH.md -##说明 + +## 说明 ### 使用场景 1) 系统框架层新增子系统,需对应用层提供接口 @@ -68,6 +69,7 @@ bool TestClass1::if_callback(std::string &v1, std::string &out) { } ``` + ### 工具开发说明 开发者可以基于已有源码进行工具二次开发,编译打包生成自定义的可执行文件和插件。工具开发说明如下: diff --git a/docs/DEVELOP_ZH.md b/docs/DEVELOP_ZH.md index 36627c21..f1677816 100644 --- a/docs/DEVELOP_ZH.md +++ b/docs/DEVELOP_ZH.md @@ -1,6 +1,6 @@ -#工具开发说明 +# 工具开发说明 -##工具开发 +## 工具开发 ### 可执行文件开发说明 1.安装typescript:在napi_generator目录下和napi_generator/src目录下分别都执行命令npm i typescript @@ -94,11 +94,11 @@ ### IntelliJ插件开发说明 //待补充 -##工具测试 +## 工具测试 进行工具二次开发后,本地可进行单元测试、特性测试确保工具的可用性。 单元测试方法如下: https://gitee.com/openharmony-sig/napi_generator/blob/master/test/unittest/README_ZH.md 特性测试方法如下: - https://gitee.com/openharmony-sig/napi_generator/blob/master/test/storytest/README_ZH.md \ No newline at end of file + https://gitee.com/openharmony-sig/napi_generator/blob/master/test/storytest/README_ZH.md diff --git a/docs/INSTRUCTION_ZH.md b/docs/INSTRUCTION_ZH.md index b0ab1a2f..e7bdfc02 100644 --- a/docs/INSTRUCTION_ZH.md +++ b/docs/INSTRUCTION_ZH.md @@ -1,5 +1,5 @@ # 使用方法 -##简介 +## 简介 工具支持三种入口,分别是可执行程序、VS插件、IntelliJ插件,在napi_generator/prebuilt目录下存有已生成的文件,用户可直接使用。 生成文件说明如下: @@ -142,12 +142,12 @@ visual studio code 版本需1.62.0及以上 ### IntelliJ插件使用方法 -####依赖 +#### 依赖 系统:不限 开发工具:IntelliJ IDEA -####使用指导 +#### 使用指导 IntelliJ插件路径:napi_generator/prebuilt/generator.jar,下载jar包后,按下述步骤安装使用: 1.新建或者打开项目工程,把需要转换的.d.ts文件放到项目中 @@ -171,4 +171,4 @@ IntelliJ插件路径:napi_generator/prebuilt/generator.jar,下载jar包后 ## 集成测试 NAPI框架代码生成后,系统框架开发者进行二次开发后,即可集成到openharmony编译系统,生成对应的库文件,供应用开发者调用接口,指导如下: -https://gitee.com/openharmony-sig/napi_generator/blob/master/docs/NAPI集成到openharmony系统集成测试.md \ No newline at end of file +https://gitee.com/openharmony-sig/napi_generator/blob/master/docs/NAPI集成到openharmony系统集成测试.md