|
24 | 24 | <p align="center">Quick build rt-thread pkg toolkits | 快速构建rt-thread pkg工具集</p> |
25 | 25 | </div> |
26 | 26 |
|
27 | | -如果您喜欢该项目觉得该项目不错的话, 请赏赐一个星星, 星星就是更新的动力! |
28 | | - |
29 | 27 | ## 简介 ([English](/readme.en.md)) |
30 | 28 |
|
31 | 29 | buildpkg 是用于生成 RT-Thread package 的快速构建工具。 |
32 | 30 |
|
33 | 31 | 一个优秀的 package 应该是这样的: |
34 | | - 1. 代码优雅,规范化。 |
| 32 | + 1. 代码优雅, 规范化。 |
35 | 33 | 2. examples 例程,提供通俗易懂的使用例程。 |
36 | 34 | 3. SConscript 文件,用于和 RT-Thread 环境一起进行编译。 |
37 | 35 | 4. README.md 文档,向用户提供必要的功能说明。 |
38 | | - 5. docs 文件夹,放置除了 README 之外的其他文档。 |
| 36 | + 5. docs 文件夹, 放置除了 README 之外的其他细节文档。 |
39 | 37 | 6. license 许可文件,版权说明。 |
40 | 38 |
|
41 | 39 | 为了方便快速的生成 RT-Thread package 规范化模板 以及 减轻开源仓库迁移 RT-Thread 的前期准备工作的负担,基于此目的的 buildpkg 应运而生,为开发 Rt-Thread 的 package 的开发者提供辅助开发工具。 |
42 | 40 |
|
43 | 41 | | 序号 | 支持功能 | 描述 | |
44 | 42 | | :--- | :--- | :--- | |
45 | 43 | | 1 | 构建 package 模板 | 创建指定名称 package , 自动添加 readme /版本号/ github ci脚本/demo/开源协议文件 | |
46 | | -| 2 | 迁移开源仓库 | 从指定 git 仓库构建 package , 自动添加readme/版本号/ github ci脚本/demo/开源协议文件, 但是迁移的仓库需要用户自己按照实际情况修改, 对于纯软件仓库且兼容RT-Thread支持标准可以无需修改 | |
47 | | -| 3 | 更新package | 生成package后可以再次更新之前设定的版本号,开源协议 | |
48 | | - |
49 | | -## 使用之前 |
50 | | -> pip install lice 或者 easy_install lice |
51 | | -
|
52 | | -## 使用方法 |
53 | | - |
54 | | -一共有两种使用方法 |
55 | | - 1. 使用 buildpkg.exe (Windows 下推荐使用) |
56 | | - 2. 使用 python 脚本 (python3 不保证兼容所有版本所有平台) |
57 | | - |
58 | | ---- |
59 | | - |
60 | | -### 使用 buildpkg.exe |
| 44 | +| 2 | 迁移开源仓库 | 从指定 git 仓库构建 package , 自动添加readme/版本号/ github ci脚本/demo/开源协议文件, 但是迁移的仓库需要用户自己按照实际情况修改 | |
| 45 | +| 3 | 更新 package | 生成package后可以再次更新之前设定的版本号,开源协议或者scons脚本等 | |
61 | 46 |
|
62 | | -#### 1. 构建package |
63 | | -> buildpkg make pkgdemo --version=v1.0.0 --license=MIT |
| 47 | +## 使用说明 |
64 | 48 |
|
65 | | -#### 2. 迁移开源仓库 |
66 | | -> buildpkg make cstring https://github.com/liu2guang/cstring.git --version=v1.0.0 --license=MIT |
| 49 | +### 1. 构建package |
| 50 | +> buildpkg.exe make pkgdemo |
67 | 51 |
|
68 | | -#### 3. 更新package |
69 | | -> buildpkg update pkgname --license=LGPLv2 --version=v1.0.1 |
| 52 | +### 2. 迁移开源仓库 |
| 53 | +> buildpkg.exe make cstring https://github.com/liu2guang/cstring.git |
70 | 54 |
|
71 | | ---- |
| 55 | +### 3. 更新package |
| 56 | +> buildpkg.exe update pkgname |
72 | 57 |
|
73 | | -### 使用 python 脚本 |
74 | | - |
75 | | -#### 1. 构建package |
76 | | -> python3 ./buildpkg.py make mypkg --version=v1.0.0 --license=MIT |
77 | | -
|
78 | | -#### 2. 迁移开源仓库 |
79 | | -> python3 ./buildpkg.py make cstring https://github.com/liu2guang/cstring.git --version=v1.0.0 --license=MIT |
80 | | -
|
81 | | -#### 3. 更新package |
82 | | -> python3 ./buildpkg.py update mypkg --version=v1.2.0 --license=GPLv3 |
83 | | -
|
84 | | ---- |
| 58 | +### 4. 可选配置 |
| 59 | +| 长参数 | 短参数 | 描述 | |
| 60 | +| :--- | :--- | :--- | |
| 61 | +| --version=v1.0.0 | -v v1.0.0 | 设置 package 的版本 | |
| 62 | +| --license=MIT | -l MIT | 设置 package 所遵循的版权协议 | |
| 63 | +| --submodule | -s |删除 git 子模块 | |
85 | 64 |
|
86 | | -## 参数说明 |
87 | | -| 参数 | 描述 | |
88 | | -| :--- | :--- | |
89 | | -| --version=v1.0.0 | 设置 package 的版本 | |
90 | | -| --license=MIT | 设置 package 所遵循的版权协议 | |
91 | | -| --remove-submodule | 删除 git 子模块 | |
92 | | ---- |
93 | 65 | ## Windows10 及 Linux 平台的演示动图 |
94 | 66 |  |
95 | | ---- |
| 67 | + |
96 | 68 | ## 测试平台 |
97 | 69 |
|
98 | 70 | | 序号 | 测试平台 | 测试结果 | |
99 | 71 | |:---|:---|:---| |
100 | | -| 1 | win10 | exe测试通过 | |
101 | | -| 2 | win7 | 待测试 | |
102 | | -| 3 | mac | py脚本不知道是否兼容, 没有测试条件, 后面维护下 | |
103 | | -| 4 | ubuntu | py脚本不知道是否兼容, 没有测试条件, 后面维护下 | |
| 72 | +| 1 | win10 | exe测试通过, py测试通过 | |
| 73 | +| 2 | win7 | exe待测试, py待测试 | |
| 74 | +| 3 | mac | py脚本不知道是否兼容, 没有测试条件, 后面维护下 | |
| 75 | +| 4 | linux | py脚本不知道是否兼容, 没有测试条件, 后面维护下 | |
104 | 76 |
|
105 | 77 | ## 联系人 |
106 | 78 |
|
|
0 commit comments