diff --git a/README_ZH.md b/README_ZH.md index 55bb7760a5852cfd0a33761bdab72387915f930d..27a15a9c4a6187d418fb9949141135cef60e010d 100755 --- a/README_ZH.md +++ b/README_ZH.md @@ -12,7 +12,7 @@ ├── napi_generator # NAPI框架代码生成工具 │ ├── docs # 工具说明、版本规划 │ ├── figures # 图片资源文件 - │ ├── prebuilt # 可执行文件、插件文件 + │ ├── prebuilt # VS Code插件文件 │ ├── release-notes # 发布说明 │ ├── src # 工具源码 | | ├── gen @@ -44,12 +44,16 @@ 工具有三种类型，分别是可执行文件、VS Code插件、IntelliJ插件。其中的可执行文件可根据工具使用者的开发环境选择，支持Windows，Linux和Mac。 -使用者可以根据自己的需要选择合适的工具，所有的工具存放在以下路径： +使用者可以根据自己的需要选择合适的工具，VS Code插件存放在以下路径： ``` napi_generator/ prebuilt ``` +可执行文件与IntelliJ插件下载路径如下： + +[下载链接](https://repo.huaweicloud.com/harmonyos/develop_tools/napi_generator/napi_generator_20220319.tart.gz) + 具体的工具使用步骤，可以左键单击以下链接了解： [工具使用说明](https://gitee.com/openharmony-sig/napi_generator/blob/master/docs/INSTRUCTION_ZH.md) diff --git a/docs/INSTRUCTION_ZH.md b/docs/INSTRUCTION_ZH.md index 67293c8cef8e89ddc8b2de0f4e62636140c147e3..30349bbd4d0b53979f8733af21b333050539f396 100755 --- a/docs/INSTRUCTION_ZH.md +++ b/docs/INSTRUCTION_ZH.md @@ -1,13 +1,21 @@ # NAPI框架生成工具使用说明 ## 简介 -NAPI框架生成工具支持三种入口，分别是可执行程序、VS Code插件、IntelliJ插件，在napi_generator/prebuilt目录下存有已生成的文件，用户可直接使用。 -生成文件说明如下： +NAPI框架生成工具支持三种入口，分别是可执行程序、VS Code插件、IntelliJ插件，使用者可以根据自己的需要选择合适的工具，VS Code插件存放在以下路径： + +``` +napi_generator/ prebuilt +``` + +可执行文件与IntelliJ插件下载路径如下： + +[下载链接](https://repo.huaweicloud.com/harmonyos/develop_tools/napi_generator/napi_generator_20220319.tart.gz) + + +下载文件说明如下： + - ├── napi_generator # NAPI框架代码生成工具 - │ ├── prebuilt # 可执行程序、插件文件 │ | ├── generator.jar # IntelliJ插件 - │ | |── gnapi-0.0.1.vsix # VS插件 │ │ |── napi_generator-linux # Linux可执行程序 │ │ |── napi_generator-win.exe # Windows可执行程序 | | └── napi_generator-macos # Mac可执行程序 @@ -132,7 +140,13 @@ visual studio code 版本需1.62.0及以上。 开发工具：IntelliJ IDEA #### 使用指导 -在napi_generator/prebuilt目录下提供了插件包，其名称为generator.jar，开发者只需要下载插件包按照下述步骤安装使用即可： +下载可执行程序与插件包generator.jar，将需要平台下的可执行文件放到以下路径中的对应平台目录下 + + napi_generator\src\generator\resources\cmds + +[下载链接](https://repo.huaweicloud.com/harmonyos/develop_tools/napi_generator/napi_generator_20220319.tart.gz) + +使用者下载插件包后，按照下述步骤安装使用即可： 1.新建或打开项目工程，以下以新建项目工程为例。 @@ -152,7 +166,7 @@ File->New->Project。 ![](../figures/IntelliJ_step_project.png) -4.安装插件，File->Settings->Plugins->Installed->Install Plugin from Disk...，选择从项目prebuilt目录下generator.jar，安装成功之后重启IDE。 +4.安装插件，File->Settings->Plugins->Installed->Install Plugin from Disk...，选择下载的generator.jar，安装成功之后重启IDE。 ![](../figures/IntelliJ_step_pluginsOk.png) diff --git a/prebuilt/End User License Agreement-templet20211215.docx b/prebuilt/End User License Agreement-templet20211215.docx deleted file mode 100755 index f83f7be777a54a74645fc350c59049823c129d9f..0000000000000000000000000000000000000000 Binary files a/prebuilt/End User License Agreement-templet20211215.docx and /dev/null differ diff --git a/prebuilt/End User License Agreement.md b/prebuilt/End User License Agreement.md new file mode 100644 index 0000000000000000000000000000000000000000..99a818f3bcad713c1350736d62cc71f5e47ea211 --- /dev/null +++ b/prebuilt/End User License Agreement.md @@ -0,0 +1,65 @@ +## End User License Agreement + +THIS END USER LICENSE AGREEMENT (“AGREEMENT”) IS A LEGAL AGREEMENT BETWEEN YOU (EITHER A SINGLE INDIVIDUAL, OR SINGLE LEGAL ENTITY) AND【 深圳开鸿数字产业发展有限公司 】 (HERE AFTER REFERRED TO AS"【 深开鸿】") FOR THE USE OF THE SOFTWARE ACCOMPANYING THIS AGREEMENT. 【 深开鸿】 IS ONLY WILLING TO LICENSE THE SOFTWARE TO YOU ON CONDITION THAT YOU ACCEPT ALL OF THE TERMS IN THIS AGREEMENT. BY DOWNDOADING OR BY INSTALLING OR OTHERWISE USING OR COPYING THE SOFTWARE YOU INDICATE THAT YOU AGREE TO BE BOUND BY ALL OF THE TERMS OF THIS AGREEMENT. IF YOU DO NOT AGREE TO THE TERMS OF THIS AGREEMENT,【深开鸿 】 WILL NOT LICENSE THE SOFTWARE TO YOU AND YOU MAY NOT INSTALL, USE OR COPY THE SOFTWARE, AND YOU SHALL PROMPTLY DESTROY, DELETE, OR RETURN THE SOFTWARE TO YOUR SUPPLIER. + +“SOFTWARE” means the software in object code provided under the terms of this Agreement. + +【Shenzhen】 is the signing place of this Agreement. + +### 1.GRANT OF LICENSE + +In consideration of your agreement to abide by the following terms, and subject to the terms and conditions of this Agreement, 【 深开鸿 】 hereby grants YOU, a non-transferable, non-exclusive, royalty-free, revocable, worldwide copyright license (without the right to sublicense) to internally use and copy the SOFTWARE to 【set up internal development environment with development boards】 , solely for the purpose of【designing, developing or testing your applications】 . + +All rights to the SOFTWARE and all intellectual property rights contained therein are reserved and shall remain the sole and exclusive property of 【 深开鸿 】. The SOFTWARE is licensed but not sold. Except as expressly licensed in Clause 1, in no event shall the license granted in this Clause 1 be construed as granting YOU expressly or by implication, estoppels or otherwise, licenses to any intellectual property rights, including but not limited to patent rights, copyrights, trademark or trade secret in the SOFTWARE. + +No right is granted to YOU under this Agreement to manufacture, have manufactured, or sell, supply or distribute any products which use or embody any of the SOFTWARE or any of the intellectual property rights embodied therein. + +### 2.RESTRICTIONS + +YOU shall reproduce and not remove or obscure any notice incorporated by 【深开鸿】 in the SOFTWARE to protect 【深开鸿 】’s intellectual property rights embodied therein. + +YOU shall not decompile, disassemble, or reverse engineer the SOFTWARE. + +YOU shall not distribute the SOFTWARE under an open source license as listed by the Open Source Initiative (a non-profit corporation whose website is www.opensource.org), or other license which requires the source code or object code of the SOFTWARE to be licensed or otherwise shared with any third party. + +### 3.CONFLICT WITH OPEN SOURCE SOFTWARE LICENSE + +The SOFTWARE may contain open source software. If the license applied on such open source software has conflict with this Agreement, the license applied on such open source software will prevail and apply to the open source software. + +### 4.FEEDBACK + +YOU may choose to provide suggestions, comments, feedback, ideas, modifications or know-how (whether in oral or written form) relating to the use of the SOFTWARE ("Feedback") to 【 深开鸿 】 under the terms of this Agreement. YOU hereby grants to 【深开鸿 】 and its affiliates, under all of you and your affiliates’ (as applicable) intellectual property rights, a perpetual, irrevocable, royalty free, non-exclusive, worldwide license to (i) use, copy and modify the Feedback; (ii) sell, supply, or otherwise distribute the Feedback; (iii) design, have designed, manufacture, have manufactured, use, import, sell, and otherwise distribute and dispose of products that incorporate the Feedback; and (iv) sublicense (together with the rights to further sublicense) the rights granted in this paragraph to any third party. + +### 5.NO WARRANTY + +YOU AGREE THAT THE SOFTWARE IS PROVIDED BY 【 深开鸿 】 ON AN "AS IS" BASIS. 【深开鸿 】 MAKES NO WARRANTY, EXPRESSED OR IMPLIED OR STATUTORY, WITH RESPECT TO ANY OF THE SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, SATISFACTORY QUALITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. + +YOU EXPRESSLY ASSUME ALL LIABILITIES AND RISKS, FOR USE OR OPERATION OF THE SOFTWARE, INCLUDING WITHOUT LIMITATION, SOFTWARE APPLICATIONS DESIGNED OR INTENDED FOR MISSION CRITICAL APPLICATIONS, SUCH AS PACEMAKERS, WEAPONRY, AIRCRAFT NAVIGATION, FACTORY CONTROL SYSTEMS, ETC. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE ENTIRE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +### 6.NO LIABILITY + +PLEASE NOTE THAT YOU SHOULD USE THE SOFTWARE AT YOUR OWN RISK. + +IN NO EVENT SHALL 【 深开鸿 】 BE LIABLE FOR ANY DIRECT OR INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE OF OR INABILITY TO USE THE SOFTWARE, WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHER LEGAL THEORY, EVEN IF 【 深开鸿 】 HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. EVEN IF THE SOFTWARE HAS ANY MATERIAL, VERIFIABLE, AND REPRODUCIBLE PROGRAM ERRORS, 【 深开鸿 】 SHALL HAVE NO LIABILITY TO MODIFY SUCH ERRORS. + +NOTWITHSTANDING ANYTHING TO THE CONTRARY CONTAINED IN THIS AGREEMENT, THE MAXIMUM LIABILITY OF 【 深开鸿】 TO YOU IN AGGREGATE FOR ALL CLAIMS MADE AGAINST 【 深开鸿】 IN CONTRACT TORT OR OTHERWISE UNDER OR IN CONNECTION WITH THE SUBJECT MATTER OF THIS AGREEMENT SHALL NOT EXCEED THE TOTAL OF SUMS RECEIVED BY 【深开鸿 】 FROM YOU FOR THIS AGREEMENT. THE EXISTENCE OF MORE THAN ONE CLAIM WILL NOT ENLARGE OR EXTEND THE LIMIT. + +### 7.CONFIDENTIALITY + +YOU acknowledge and agree that the SOFTWARE provided under this Agreement contain trade secrets and confidential material of 【 深开鸿】 and YOU agree to maintain all such information in confidence and apply security measures no less stringent than the measures which YOU apply to protect your own like information, but not less than a reasonable degree of care, to prevent their unauthorized disclosure and use. The period of confidentiality shall be indefinite. YOU agree not to use any such information other than in normal use of the SOFTWARE under the license granted in this Agreement. + +### 8.TERM AND TERMINATION + +This Agreement shall remain in force until terminated. 【 深开鸿 】 may terminate this Agreement at any time with or without any cause. Upon termination of this Agreement, YOU shall immediately stop using the SOFTWARE and confidential information and destroy all copies of the SOFTWARE and confidential information in your possession, together with all documentation and related materials. The provisions of clauses 2, 3, 4, 5, 6, 7，8 and 9 shall survive termination of this Agreement. + +### 9.GENERAL + +Any provision of this Agreement which is prohibited or unenforceable in any jurisdiction shall be ineffective to the extent of such prohibition or unenforceability without affecting, impairing or invalidating the remaining provisions hereof. + +The failure by 【深开鸿】 to enforce any of the provisions of this Agreement, unless waived in writing, shall not constitute a waiver of 【深开鸿】's rights to enforce such provision or any other provision of this Agreement in the future. + +This Agreement shall be governed by and construed in accordance with the laws of People’s Republic of China, without reference to the principles of conflicts of laws. Any dispute arising out of or relating to this Agreement shall be submitted to 【Shenzhen】and the parties waive all objections to that jurisdiction and venue. + +-------------------------------------------------------------------- + +Copyright (C) 【2022】【深圳开鸿数字产业发展有限公司】 All rights reserved. \ No newline at end of file diff --git a/src/generator/resources/cmds/linux/INTELLIJ_README_LINUX_zh.md b/src/generator/resources/cmds/linux/INTELLIJ_README_LINUX_zh.md index 240a5ac0cff72077d019d71a44c62828b1d3b742..1b8c11eee30ca1ee7fc8c3f4b872158faca40bbf 100644 --- a/src/generator/resources/cmds/linux/INTELLIJ_README_LINUX_zh.md +++ b/src/generator/resources/cmds/linux/INTELLIJ_README_LINUX_zh.md @@ -1,2 +1,4 @@ # 目录说明 - 此目录用于存放napi_generator-linux可执行文件，可执行文件下载路径为： \ No newline at end of file + 此目录用于存放napi_generator-linux可执行文件 + +[可执行文件下载](https://repo.huaweicloud.com/harmonyos/develop_tools/napi_generator/napi_generator_20220319.tart.gz) \ No newline at end of file diff --git a/src/generator/resources/cmds/mac/INTELLIJ_README_MAC_zh.md b/src/generator/resources/cmds/mac/INTELLIJ_README_MAC_zh.md index 1aff99590b08b6089ef1bd974b3ab7df4b75b51e..75f137f8d0975e5fae73239aa7faca703f234f8a 100644 --- a/src/generator/resources/cmds/mac/INTELLIJ_README_MAC_zh.md +++ b/src/generator/resources/cmds/mac/INTELLIJ_README_MAC_zh.md @@ -1,2 +1,4 @@ # 目录说明 - 此目录用于存放napi_generator-macos可执行文件，可执行文件下载路径为： \ No newline at end of file + 此目录用于存放napi_generator-macos可执行文件 + +[可执行文件下载](https://repo.huaweicloud.com/harmonyos/develop_tools/napi_generator/napi_generator_20220319.tart.gz) \ No newline at end of file diff --git a/src/generator/resources/cmds/win/INTELLIJ_README_WIN_zh.md b/src/generator/resources/cmds/win/INTELLIJ_README_WIN_zh.md index a58b9eb0670ce1a5727be9c67e09fb3495de01c8..41cc6fa6943aad0cd5059db686af0637d61da6a8 100644 --- a/src/generator/resources/cmds/win/INTELLIJ_README_WIN_zh.md +++ b/src/generator/resources/cmds/win/INTELLIJ_README_WIN_zh.md @@ -1,2 +1,4 @@ # 目录说明 - 此目录用于存放napi_generator-win.exe可执行文件，可执行文件下载路径为： \ No newline at end of file + 此目录用于存放napi_generator-win.exe可执行文件 + +[可执行文件下载](https://repo.huaweicloud.com/harmonyos/develop_tools/napi_generator/napi_generator_20220319.tart.gz) \ No newline at end of file