浏览代码

更新用户文档

Jomocool 6 月之前
父节点
当前提交
d5c40905a1
共有 1 个文件被更改,包括 87 次插入0 次删除
  1. 87 0
      docs/user-manual/README.md

+ 87 - 0
docs/user-manual/README.md

@@ -1,3 +1,90 @@
 # 用户指南
 
+## 用户程序配置文件模版
+在dadk-config/templates/config/目录下,可以找到用户程序的配置文件模版`userapp_config.toml`
+```toml
+# 用户程序名称
+name = "userapp_config"
+
+# 版本号
+version = "0.2.0"
+
+# 用户程序描述信息
+description = ""
+
+# (可选)默认: false 是否只构建一次,如果为true,DADK会在构建成功后,将构建结果缓存起来,下次构建时,直接使用缓存的构建结果
+build-once = false
+
+#  (可选) 默认: false 是否只安装一次,如果为true,DADK会在安装成功后,不再重复安装
+install-once = false
+
+# 目标架构
+# 可选值:"x86_64", "aarch64", "riscv64"
+target-arch = ["x86_64"]
+
+# 任务源
+[task-source]
+
+# 构建类型
+# 可选值:"build-from_source", "install-from-prebuilt"
+type = "build-from-source"
+
+# 构建来源
+# "build_from_source" 可选值:"git", "local", "archive"
+# "install_from_prebuilt" 可选值:"local", "archive"
+source = "git"
+
+# 路径或URL
+source-path = "https://git.mirrors.dragonos.org.cn/DragonOS-Community/test_git.git"
+
+# git标签或分支
+# 注意: branch和revision只能二选一,且source要设置为"git"
+revision = "01cdc56863"
+# branch = "test"
+
+# 构建相关信息
+[build]
+
+# (可选)构建命令
+build-command = "make install"
+
+# (可选)预构建脚本路径
+pre-build = "config/pre_build.sh"
+
+# (可选)构建后脚本路径
+post-build = "config/post_build.sh"
+
+# 安装相关信息
+[install]
+
+# (可选)安装到DragonOS的路径
+in-dragonos-path = "/bin"
+
+# 清除相关信息
+[clean]
+
+# (可选)清除命令
+clean-command = "make clean"
+
+# (可选)依赖项
+# 注意:如果没有依赖项,忽略此项,不允许只留一个[[depends]]
+[[depends]]
+name = "depend1"
+version = "0.1.1"
+
+[[depends]]
+name = "depend2"
+version = "0.1.2"
+
+# (可选)环境变量
+[[envs]]
+key = "PATH"
+value = "/usr/bin"
+
+[[envs]]
+key = "LD_LIBRARY_PATH"
+value = "/usr/lib"
+
+```
+
 TODO