组织介绍

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
成就
3
Star
91
Fork
成员(2)
闻飞
飞翔在天

搜索帮助