From 3809e8c4b7a0433a536318867b7c0fe85301ef56 Mon Sep 17 00:00:00 2001
From: xiaojiazhu <258828110.@qq.com>
Date: Sat, 4 May 2024 09:56:22 -0700
Subject: [PATCH] Improve:doxygen.

---
 Doxyfile  |  6 +++---
 README.md | 37 +++++++++++++++++++++++++++++--------
 2 files changed, 32 insertions(+), 11 deletions(-)

diff --git a/Doxyfile b/Doxyfile
index d74a1935..4fdae1ca 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "My Project"
+PROJECT_NAME           = "Fancy code"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version
@@ -829,7 +829,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ./application ./middleware ./hal ./utils ./test
+INPUT                  = ./application ./middleware ./hal ./utils ./test ./README.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1026,7 +1026,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = ./README.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing
diff --git a/README.md b/README.md
index c040b820..2d68d0aa 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,36 @@
 # 1. README
 
-## 1.1. 编译
+## 1.1. 概述
 
-&emsp;&emsp; 架构设计上支持去平台编译和运行。
+&emsp;&emsp;基于IPC领域产品的SDK工程。
 
-### 1.1.1. Ubuntu系统
+阅读小技巧：
+
+* 本工程所有文档描述路径时，"//"双斜杠表示工程根目录；
+
+## 1.2. 编译
+
+&emsp;&emsp;架构设计上支持去平台编译和运行，本仓库源码可仿真运行在ubuntu系统。
+
+### 1.2.1. Ubuntu系统
 
 在项目根目录下执行命令：
 ```
-make clean  // 如果之前有跨平台编译过，需要先make clean
-make cmake  // 构建源码，生成Makefile文件
-cd cmake-shell/   // 在中间文件目录进行编译，把所有中间文件创建在此目录
-make        // 编译全部输出构建文件
-```
\ No newline at end of file
+make clean         // 如果之前有跨平台编译过，需要先make clean
+make cmake         // 构建源码，生成Makefile文件
+cd cmake-shell/    // 在中间文件目录进行编译，把所有中间文件创建在此目录
+make               // 编译全部输出构建文件
+```
+
+### 1.2.2. 交叉编译
+
+参考：
+
+```
+//build/cmake/toolchain/linux.toolchain.cmake
+//Makefile
+```
+
+&emsp;&emsp;参考上述文件新建一份配置文件，建议不要修改原文档，新建一个交叉编译工程，把IPC SDK工程作为子仓库进行git管理，维护SDK的绝对跨平台属性。
+
+&emsp;&emsp;交叉编译请参考基于IPC SDK作为子仓库的工程配置，此处忽略。
\ No newline at end of file