2 Star 2 Fork 2

itopen / Document

forked from PersonalSummary / Document 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

OpenHarmony项目基础文档介绍

目录

一、必看文档

1.1 手册指导

1.2 鸿蒙代码编写规范要求

鸿蒙代码规范要求具体参见鸿蒙官方网站的贡献指南,对于一些常用的语言规范可参考Openharmony代码规范

1.3 环境配置指导

二、文档规范要求

​ 该仓的设立主要是方便OpenHarmony的兄弟们平时总结和学习,因此为了方便更好的起到文档及时搜索和及时查阅的效果,因此对该仓的文档编写、提交提出以下要求:

  • 该仓的文档严禁涉及信息安全、项目中保密内容,所有文档内容应是可公开传播的
  • 文档更新的同时需要更新同目录下的README.md文档,方便其他人员查阅
  • 如果新建目录,需要添加README.md文档,同时在上级目录的README.md文档中进行更新
  • 更新的文档需注明文档的编写者
  • 该仓已经设置严禁fork操作,不允许在线编辑操作
  • 该仓仅允许上传文档和图片,严禁上传音视频等超过50M的文件
  • 仓内的文档会定期检查,如果未按照上述规范会有被清理的风险

三、文档编写要求

3.1 文档格式要求

​ 为了方便线上能够直接阅读,文档尽可能的使用MarkDown文档,如果有必要使用其他文档,请在对应目录下的README.md中尽可能的介绍该文档的功能和作用,以方便其他人员能够快速查找。

​ MarkDown文档的编辑指导参见:Markdown文档编写指导

3.2 文档编写要求

  • 对应的目录下必须有README.md

  • README.md的要包含当前目录下的所有文档列表、文档编写者

  • README.md要对当前目录的功能进行尽可能的详细介绍说明

  • 图片一律保存在img目录下对应的文档名内

  • 文档中的图片一律使用相对路径

四、文档目录介绍

4.1 文档列表树

参考目录树,详细列表见附录一:文件列表树

tree -L 5 -I "gn_src" | grep -v "gif" | grep -v "jpg" | grep -v "png" | grep -v ".c" | grep -v ".h" > tree.md

4.2 目录介绍

目录名 目录介绍
基础语言介绍 常用语言的基础知识介绍
基础技能 平时涉及到的一些基础知识点汇集总结
OpenHarmony技术介绍 OpenHarmony相关的知识点汇集总结

附录一:文件列表树

.
├── README.md
├── basic_language
│   ├── C
│   │   ├── README.md
│   │   └── tree.md
│   ├── C++
│   │   ├── README.md
│   │   └── tree.md
│   ├── Python
│   │   ├── README.md
│   │   ├── python_common_command.md
│   │   └── tree.md
│   ├── README.md
│   ├── Shell
│   │   ├── README.md
│   │   └── tree.md
│   ├── bat
│   │   ├── README.md
│   │   ├── bat_guide.md
│   │   └── tree.md
│   └── tree.md
├── basic_skills
│   ├── GtestTddXts
│   │   ├── README.md
│   │   ├── gtest_develop_introduction.md
│   │   ├── tree.md
│   │   └── xts_develop_guide.md
│   ├── Kconfig
│   │   ├── KconfigProgram.md
│   │   ├── README.md
│   │   └── tree.md
│   ├── Makefile
│   │   ├── GNU_makefile中文手册.pdf
│   │   ├── MakefileProgrammer.md
│   │   ├── README.md
│   │   ├── tree.md
│   │   └── 跟我一起写Makefile-陈皓.pdf
│   ├── README.md
│   ├── env
│   │   ├── MarkDownOps.md
│   │   ├── README.md
│   │   ├── board_to_windows_by_nfs.md
│   │   ├── board_to_windows_by_tftp.md
│   │   ├── build_jenkins_env.md
│   │   ├── repo_download_code.md
│   │   ├── tree.md
│   │   ├── ubuntu_env_config.md
│   │   └── wsl_env_config.md
│   ├── git
│   │   ├── README.md
│   │   ├── git_guide.md
│   │   └── tree.md
│   ├── gn
│   │   ├── README.md
│   │   ├── gn-help.md
│   │   ├── gn_docs
│   │   │   ├── UsingGNbuild.pdf
│   │   │   ├── gn-language.pdf
│   │   │   ├── gn-quick_start.pdf
│   │   │   └── gn-reference.pdf
│   │   ├── gn_grammar.md
│   │   └── tree.md
│   ├── patch
│   │   ├── README.md
│   │   ├── create_patch_method.md
│   │   └── tree.md
│   └── tree.md
├── code_commit_guide.md
├── code_download_and_complier.md
├── img
│   ├── basic_skills
│   │   ├── GoogleTest_Tdd_Xts
│   │   │   ├── gtest_develop_introduction
│   │   │   └── xts_develop_guide
│   │   ├── env
│   │   │   ├── board_to_windows_by_nfs
│   │   │   ├── build_jenkins_env
│   │   │   └── repo_download_code
│   │   └── makefile
│   │       └── MakefileProgrammer
│   ├── code_commit_ops
│   └── openharmony_skills
│       ├── basic_skills
│       │   ├── OpenHarmonyCodeCommit
│       │   └── RK3568_basic_guide
│       └── kernel_guide
│           └── hdf_module
│               └── HdfSListFunc
├── openharmony_skills
│   ├── README.md
│   ├── basic_skills
│   │   ├── OpenHarmonyCodeCommit.md
│   │   ├── README.md
│   │   ├── RK3568_basic_guide.md
│   │   └── tree.md
│   ├── code_write_specification
│   │   ├── FAQ.md
│   │   ├── OpenHarmony-64bits-coding-guide.md
│   │   ├── OpenHarmony-Java-secure-coding-guide.md
│   │   ├── OpenHarmony-JavaScript-coding-style-guide.md
│   │   ├── OpenHarmony-JavaScript-docs-guide.md
│   │   ├── OpenHarmony-Log-guide.md
│   │   ├── OpenHarmony-c-coding-style-guide.md
│   │   ├── OpenHarmony-c-cpp-secure-coding-guide.md
│   │   ├── OpenHarmony-cpp-coding-style-guide.md
│   │   ├── OpenHarmony-hdf-coding-guide.md
│   │   ├── OpenHarmony-security-design-guide.md
│   │   ├── OpenHarmony-security-test-guide.md
│   │   ├── README.md
│   │   ├── Readme-CN.md
│   │   ├── docs-release-process.md
│   │   ├── docs-reviewers.md
│   │   ├── figures
│   │   ├── prebuilts-readme-template.md
│   │   ├── public_sys-resources
│   │   ├── style-guide
│   │   │   ├── Readme-CN.md
│   │   │   ├── figures
│   │   │   ├── style-guide-content-elements.md
│   │   │   ├── style-guide-document-structure.md
│   │   │   ├── style-guide-language-style.md
│   │   │   └── style-guide-overview.md
│   │   ├── template
│   │   │   ├── README-template.md
│   │   │   ├── errorcodes-template.md
│   │   │   ├── faq-template.md
│   │   │   ├── figures
│   │   │   ├── guide-template.md
│   │   │   ├── js-template.md
│   │   │   ├── ts-template.md
│   │   │   ├── tutorial-template.md
│   │   │   └── xxboard-template.md
│   │   ├── tree.md
│   │   ├── 写作规范.md
│   │   ├── 参与贡献.md
│   │   ├── 社区沟通与交流.md
│   │   ├── 第三方开源软件及许可证说明.md
│   │   ├── 第三方开源软件引入指导.md
│   │   ├── 行为准则.md
│   │   ├── 许可证与版权规范.md
│   │   ├── 贡献代码.md
│   │   ├── 贡献文档.md
│   │   └── 贡献流程.md
│   ├── kernel_guide
│   │   ├── README.md
│   │   ├── hdf_module
│   │   │   ├── HCB_Analysis.md
│   │   │   ├── HDFInterface.md
│   │   │   ├── HdfDListFunc.md
│   │   │   ├── HdfSListFunc.md
│   │   │   ├── README.md
│   │   │   ├── attachment
│   │   │   │   └── hdf的slist操作图.eddx
│   │   │   └── tree.md
│   │   ├── kernel_tracepoint_guide
│   │   │   ├── README.md
│   │   │   ├── tracepoint_demo_guide.md
│   │   │   ├── tracepoint_guide.md
│   │   │   └── tree.md
│   │   ├── liteos_a
│   │   │   ├── README.md
│   │   │   ├── liteos_a_start_armv7.md
│   │   │   ├── memory
│   │   │   │   └── 获取L2基地址.xlsx
│   │   │   └── tree.md
│   │   └── tree.md
│   └── tree.md
└── tree.md

49 directories, 225 files
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

OpenHarmony基础操作描述 展开 收起
C++
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
C++
1
https://gitee.com/itopen/document.git
git@gitee.com:itopen/document.git
itopen
document
Document
master

搜索帮助