# Documents **Repository Path**: wang-yanqinq/documents ## Basic Information - **Project Name**: Documents - **Description**: 本项目的文档管理 - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 9 - **Created**: 2022-04-18 - **Last Updated**: 2022-05-24 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # OpenHarmony文档介绍 ## 目录 - [文档编写规范要求](#文档编写规范要求) - [文档编写要求](#文档编写要求) - [文档列表](#文档列表) - [documents仓权限申请](#仓权限申请) - [附录一：文件列表树](#文件列表树) ## 一、文档编写规范要求该仓的设立主要是方便OpenHarmony的兄弟们平时总结和学习，因此为了方便更好的起到文档及时搜索和及时查阅的效果，因此对该仓的文档编写、提交提出以下要求： - **该仓的文档严禁涉及信息安全、项目中保密内容，所有文档内容应是可公开传播的** - 文档更新的同时需要更新同目录下的README.md文档，方便其他人员查阅 - 如果新建目录，需要添加README.md文档，同时在上级目录的README.md文档中进行更新 - 更新的文档需注明文档的编写者 - 该仓已经设置严禁fork操作，不允许在线编辑操作 - 该仓仅允许上传文档和图片，严禁上传音视频等超过50M的文件 - 仓内的文档会定期检查，如果未按照上述规范会有被清理的风险 - 新成员申请权限操作方法参见：[仓权限申请](#仓权限申请) - 文档编写要求说明：[文档编写要求](#文档编写要求) ## 二、文档编写要求 ### 2.1 文档格式要求为了方便线上能够直接阅读，文档尽可能的使用MarkDown文档，如果有必要使用其他文档，请在对应目录下的README.md中尽可能的介绍该文档的功能和作用，以方便其他人员能够快速查找。 MarkDown文档的编辑指导参见：[MarkDown文档编辑指导](./新员工必学/常用开发工具的使用说明/MarkDown文档编辑指导.md) ### 2.2 文档编写要求 - 对应的目录下必须有README.md - README.md的要包含当前目录下的所有文档列表、文档编写者 - README.md要对当前目录的功能进行尽可能的详细介绍说明 - 图片一律保存在img目录下对应的文档名内例如： `新员工必学/OpenHarmony必备知识/Harmony代码下载编译和烧录.md`里插入的图片应该保存在`img/新员工必学/OpenHarmony必备知识/Harmony代码下载编译和烧录`目录里面 - 文档中的图片一律使用相对路径 ### 2.3 文档编写推荐方法 - 每个标题后插入一个标签tag，文档内需要跳转链接时候方便，标题跳转在网页上用不了 - 如果目录下有其他格式的文档时，在README.md中应详细介绍 - 非必要目录的层级尽可能少 ## 三、文档列表 ### 3.1 文档列表树参考[目录树](./tree)，详细列表见[附录一：文件列表树](#文件列表树) tree -L 4 -I "gn_src" | grep -v "gif" | grep -v "jpg" | grep -v "png" | grep -v "\.c" | grep -v "\.h" > tree.md ### 3.2 目录介绍 | 文档名 | 文档介绍 | | :------------------------------------------------- | ---------------------------------- | | [技术栈资料汇总介绍](./新员工必学/README.md) | 项目中的规范、指导、资料路径介绍等 | | [新员工必学](./新员工必学/README.md) | 项目中的规范、指导、资料路径介绍等 | | [arm手册资料](./arm手册资料/README.md) | arm手册资料 | | [Build编译相关资料](./Build编译相关资料/README.md) | 编译相关的文档 | | [code](./code/README.md) | 存放一些demo代码的 | | [gtest_xts介绍](./gtest_xts介绍/README.md) | GoogleTest和XTS相关的文档 | | [img](./img/README.md) | 存放md文档中的图片 | | [OpenHarmony介绍](./OpenHarmony介绍/README.md) | 鸿蒙文档存放位置 | | [temp](./temp) | 临时文件 | | [君正X2000移植](./君正X2000移植/README.md) | 君正开发板的资料 | | [驱动介绍](./驱动介绍/README.md) | 驱动相关的 | ## 四、documents仓权限申请 ### 4.1 直接点击以下链接申请权限 https://gitee.com/halley5/documents/invite_link?invite=dadd14997da9bf7986a171142a06eba77abcbf92f63f78b9b7993663152babc552898748f5f8cefa5f318cd36bbddc3a ### 4.2 如果上述方法方法过期，请联系郭彬处理 ## 附录一：文件列表树 ``` . ├── Build编译相关资料 │ ├── BUILD.gn大致执行流程.md │ ├── BUILD.gn语法.md │ ├── Kconfig语法.md │ ├── README.md │ ├── gn-help.md │ ├── gn官方资料 │ │ ├── UsingGNbuild.pdf │ │ ├── gn-language.pdf │ │ ├── gn-quick_start.pdf │ │ └── gn-reference.pdf │ ├── python脚本中常用的命令.md │ └── tree.md ├── OpenHarmony介绍 │ ├── OpenHarmony代码规范 │ │ ├── FAQ.md │ │ ├── OpenHarmony-Java-secure-coding-guide.md │ │ ├── OpenHarmony-JavaScript-coding-style-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-security-design-guide.md │ │ ├── README.md │ │ ├── Readme-CN.md │ │ ├── docs-release-process.md │ │ ├── docs-reviewers.md │ │ ├── figures │ │ ├── public_sys-resources │ │ ├── template │ │ │ ├── concept-overview-template.md │ │ │ ├── faq-template.md │ │ │ ├── guide-template.md │ │ │ ├── js-template.md │ │ │ └── tutorial-template.md │ │ ├── tree.md │ │ ├── 写作规范.md │ │ ├── 华为云检查代码规范操作流程.md │ │ ├── 参与贡献.md │ │ ├── 社区沟通与交流.md │ │ ├── 第三方开源软件及许可证说明.md │ │ ├── 第三方开源软件引入指导.md │ │ ├── 行为准则.md │ │ ├── 许可证与版权规范.md │ │ ├── 贡献代码.md │ │ ├── 贡献指南.md │ │ ├── 贡献文档.md │ │ └── 贡献流程.md │ ├── OpenHarmony基础能力 │ │ ├── Harmony代码下载编译和烧录.md │ │ ├── OpenHarmony的代码提交流程.md │ │ ├── README.md │ │ ├── RK3568开发参考.md │ │ ├── RPC_IPC代码分支仓配置和下载.md │ │ ├── tree.md │ │ ├── 代码分支创建和拉取.md │ │ ├── 使用tftp在windows与开发板之间传输文件.md │ │ └── 单板nfs挂载Windows下目录.md │ ├── OpenHarmony模块介绍 │ │ ├── HDF驱动框架介绍 │ │ │ ├── HCB格式介绍.md │ │ │ ├── README.md │ │ │ └── tree.md │ │ ├── README.md │ │ ├── dsoftbus软总线介绍 │ │ │ ├── README.md │ │ │ ├── tree.md │ │ │ ├── 状态机_孙旭辉.pdf │ │ │ ├── 组网_孙旭辉.pdf │ │ │ └── 退网_孙旭辉.pdf │ │ ├── tree.md │ │ └── 内核介绍 │ │ ├── README.md │ │ ├── liteos_a │ │ └── tree.md │ ├── README.md │ └── tree.md ├── README.md ├── arm手册资料 │ ├── ARMCortex_A9TechnicalReferenceManual.pdf │ ├── ARM_Architecture_Reference_Manual.pdf │ ├── ARM_Cortex-A_Series.pdf │ ├── README.md │ └── tree.md ├── code │ ├── README.md │ ├── driver_code │ │ ├── chrdev_demo │ │ │ ├── Makefile │ │ └── platform_demo │ │ ├── Makefile │ ├── harmony_template │ │ └── driver_demo │ │ ├── BUILD.gn │ │ ├── Kconfig │ │ ├── Makefile │ │ ├── include │ │ └── src │ └── tree.md ├── gtest_xts介绍 │ ├── GoogleTest框架搭建和用例开发.md │ ├── README.md │ ├── tree.md │ └── xts开发指导.md ├── img │ ├── CP0 │ ├── CP0_32 │ ├── DevCloud │ ├── gtest_xts介绍 │ │ ├── GoogleTest框架搭建和用例开发 │ │ └── xts开发指导 │ ├── img │ ├── interrupt │ ├── mips_doc │ │ ├── mips_instruct_and_register │ │ └── mips_register │ ├── nfs │ ├── operation_manual │ │ ├── Makefile │ │ ├── code_branch_fetch_and_create │ │ ├── code_download_compiler │ │ └── code_merge │ └── 新员工必学 ├── temp │ ├── DeviceManagerStart.txt │ ├── README.md │ ├── chipdemo.md │ └── mips │ ├── Makefile │ ├── main │ ├── main.S │ ├── main.i │ ├── main.o │ └── mips汇编指令集.md ├── tree.md ├── 君正X2000移植 │ ├── MIPS架构介绍 │ │ ├── MIPS体系结构文档第3章.md │ │ ├── MIPS寄存器分类.md │ │ ├── MIPS指令文档.md │ │ ├── Mips中断和异常.md │ │ ├── Mips协处理器.md │ │ ├── mips_arch_porting.md │ │ ├── mips参考资料汇集.md │ │ ├── mips指令概述.md │ │ ├── mips汇编指令用法.md │ │ ├── 一些概念性的东西.docx │ │ ├── 寄存器文档.docx │ │ ├── 指令文档.docx │ │ └── 指令文档按功能分.docx │ ├── mips架构开发文档.md │ ├── 君正X2000资料 │ │ ├── X2000_DS_v0.9.pdf │ │ └── 君正x2000资料汇集.md │ └── 君正x2000代码配置更新.md ├── qemu相关 │ ├── qemu_small_system_demo平台编译和挂载nfs问题解决方案.md │ ├── README.md │ ├── tree.md ├── 新员工必学 │ ├── Git使用介绍 │ │ ├── Git命令介绍和使用.md │ │ ├── README.md │ │ └── tree.md │ ├── Makefile参考资料 │ │ ├── GNU_makefile中文手册.pdf │ │ ├── Makefile基础介绍.md │ │ ├── README.md │ │ ├── tree.md │ │ └── 跟我一起写Makefile-陈皓.pdf │ ├── README.md │ ├── tree.md │ ├── 可信考试专栏 │ │ ├── README.md │ │ └── tree.md │ ├── 常用开发工具的使用说明 │ │ ├── MarkDown文档编辑指导.md │ │ ├── README.md │ │ ├── Ubuntu环境配置.md │ │ ├── Win10电脑安装配置WSL方法.md │ │ ├── svn使用指导.md │ │ └── tree.md │ ├── 新员工培训和考核要求.md │ └── 项目规章制度介绍.md └── 驱动介绍 ├── README.md ├── tree.md └── 驱动基础知识介绍.md 53 directories, 559 files ```