forked from openkylin/docs
【轻量级 PR】:update 社区开发指南/openKylin打包指南.md.
第一,修改句子以使其便于理解。原句:"作为一种替代源码编译安装的方式,打包,即制作DEB软件包,将应用程序的二进制文件,配置文档,man/info帮助页面等文件合并打包在一个文件中,从而使软件的安装变得简单起来。通过软件包管理器,完成获取,安装,卸载,查询等一系列操作。" 修改了理解困难的地方,为句子增加了缺少的主语:“打包,即制作DEB软件包,【将会把】应用程序的二进制文件,配置文档,man/info帮助页面等文件合并打包在一个文件中,从而使软件的安装变得简单起来。通过软件包管理器,【用户】可完成获取,安装,卸载,查询等一系列操作”。 第二,统一为并列的项目短句设置了无序列表的格式。更便于阅读的同时,能够和本文其他部分的列表风格保持一致。 Signed-off-by: Marvin <marvin2022@buaa.edu.cn>
This commit is contained in:
parent
44d326c561
commit
709292bd7c
|
@ -18,20 +18,20 @@ dateCreated: 2022-05-17T07:44:07.346Z
|
|||
|
||||
写作本文档时,遵循下列指导原则:
|
||||
|
||||
仅提供概览,而忽略边界情况。(**Big Picture 原则**)
|
||||
- 仅提供概览,而忽略边界情况。(**Big Picture 原则**)
|
||||
|
||||
保持文字简短紧凑。(**KISS 原则**)
|
||||
- 保持文字简短紧凑。(**KISS 原则**)
|
||||
|
||||
不重复造轮子。(使用链接指向**已有参考**)
|
||||
- 不重复造轮子。(使用链接指向**已有参考**)
|
||||
|
||||
专注于使用非图形的工具和控制台。(使用 **shell 例子**)
|
||||
- 专注于使用非图形的工具和控制台。(使用 **shell 例子**)
|
||||
|
||||
保持客观。(使用 [popcon](http://popcon.debian.org/) 等等)
|
||||
- 保持客观。(使用 [popcon](http://popcon.debian.org/) 等等)
|
||||
|
||||
### **1. 软件打包**
|
||||
|
||||
|
||||
一个 openKylin 下的软件包通常包含一系列文件的集合,它们定义了应用程序或者库文件可以如何通过包管理器(比如apt,yum等)进行发行部署。作为一种替代源码编译安装的方式,打包,即制作DEB软件包,将应用程序的二进制文件,配置文档,man/info帮助页面等文件合并打包在一个文件中,从而使软件的安装变得简单起来。通过软件包管理器,完成获取,安装,卸载,查询等一系列操作。
|
||||
一个 openKylin 下的软件包通常包含一系列文件的集合,它们定义了应用程序或者库文件可以如何通过包管理器(比如apt,yum等)进行发行部署。作为一种替代源码编译安装的方式,打包,即制作DEB软件包,将会把应用程序的二进制文件,配置文档,man/info帮助页面等文件合并打包在一个文件中,从而使软件的安装变得简单起来。通过软件包管理器,用户可完成获取,安装,卸载,查询等一系列操作。
|
||||
|
||||
**1.1. 总体规则**
|
||||
|
||||
|
@ -69,21 +69,21 @@ dateCreated: 2022-05-17T07:44:07.346Z
|
|||
这里给出一些技术上的建议,参考行事可以让您与其他维护者共同维护软件包时变得更加轻松有效,从而让
|
||||
openKylin 项目的输出成果最大化。
|
||||
|
||||
让您的软件包容易除错(debug)。
|
||||
- 让您的软件包容易除错(debug)。
|
||||
|
||||
保持您的软件包简单易懂。
|
||||
- 保持您的软件包简单易懂。
|
||||
|
||||
不要对软件包过度设计。
|
||||
- 不要对软件包过度设计。
|
||||
|
||||
让您的软件包拥有良好的文档记录。
|
||||
- 让您的软件包拥有良好的文档记录。
|
||||
|
||||
使用可读的代码风格。
|
||||
- 使用可读的代码风格。
|
||||
|
||||
在代码中写注释。
|
||||
- 在代码中写注释。
|
||||
|
||||
格式化代码使其风格一致。
|
||||
- 格式化代码使其风格一致。
|
||||
|
||||
维护软件包的 git 仓库。
|
||||
- 维护软件包的 git 仓库。
|
||||
|
||||
### **2. 打包规则**
|
||||
|
||||
|
|
Loading…
Reference in New Issue