Skip to content

Commit

Permalink
[更新] 更新readme.md内容
Browse files Browse the repository at this point in the history
  • Loading branch information
liu2guang committed Sep 27, 2018
1 parent 4314bce commit 687c3e9
Showing 1 changed file with 22 additions and 50 deletions.
72 changes: 22 additions & 50 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,83 +24,55 @@
<p align="center">Quick build rt-thread pkg toolkits | 快速构建rt-thread pkg工具集</p>
</div>

如果您喜欢该项目觉得该项目不错的话, 请赏赐一个星星, 星星就是更新的动力!

## 简介 ([English](/readme.en.md))

buildpkg 是用于生成 RT-Thread package 的快速构建工具。

一个优秀的 package 应该是这样的:
1. 代码优雅规范化。
1. 代码优雅, 规范化。
2. examples 例程,提供通俗易懂的使用例程。
3. SConscript 文件,用于和 RT-Thread 环境一起进行编译。
4. README.md 文档,向用户提供必要的功能说明。
5. docs 文件夹放置除了 README 之外的其他文档
5. docs 文件夹, 放置除了 README 之外的其他细节文档
6. license 许可文件,版权说明。

为了方便快速的生成 RT-Thread package 规范化模板 以及 减轻开源仓库迁移 RT-Thread 的前期准备工作的负担,基于此目的的 buildpkg 应运而生,为开发 Rt-Thread 的 package 的开发者提供辅助开发工具。

| 序号 | 支持功能 | 描述 |
| :--- | :--- | :--- |
| 1 | 构建 package 模板 | 创建指定名称 package , 自动添加 readme /版本号/ github ci脚本/demo/开源协议文件 |
| 2 | 迁移开源仓库 | 从指定 git 仓库构建 package , 自动添加readme/版本号/ github ci脚本/demo/开源协议文件, 但是迁移的仓库需要用户自己按照实际情况修改, 对于纯软件仓库且兼容RT-Thread支持标准可以无需修改 |
| 3 | 更新package | 生成package后可以再次更新之前设定的版本号,开源协议 |

## 使用之前
> pip install lice 或者 easy_install lice
## 使用方法

一共有两种使用方法
1. 使用 buildpkg.exe (Windows 下推荐使用)
2. 使用 python 脚本 (python3 不保证兼容所有版本所有平台)

---

### 使用 buildpkg.exe
| 2 | 迁移开源仓库 | 从指定 git 仓库构建 package , 自动添加readme/版本号/ github ci脚本/demo/开源协议文件, 但是迁移的仓库需要用户自己按照实际情况修改 |
| 3 | 更新 package | 生成package后可以再次更新之前设定的版本号,开源协议或者scons脚本等 |

#### 1. 构建package
> buildpkg make pkgdemo --version=v1.0.0 --license=MIT
## 使用说明

#### 2. 迁移开源仓库
> buildpkg make cstring https://github.com/liu2guang/cstring.git --version=v1.0.0 --license=MIT
### 1. 构建package
> buildpkg.exe make pkgdemo
#### 3. 更新package
> buildpkg update pkgname --license=LGPLv2 --version=v1.0.1
### 2. 迁移开源仓库
> buildpkg.exe make cstring https://github.com/liu2guang/cstring.git
---
### 3. 更新package
> buildpkg.exe update pkgname
### 使用 python 脚本

#### 1. 构建package
> python3 ./buildpkg.py make mypkg --version=v1.0.0 --license=MIT
#### 2. 迁移开源仓库
> python3 ./buildpkg.py make cstring https://github.com/liu2guang/cstring.git --version=v1.0.0 --license=MIT
#### 3. 更新package
> python3 ./buildpkg.py update mypkg --version=v1.2.0 --license=GPLv3
---
### 4. 可选配置
| 长参数 | 短参数 | 描述 |
| :--- | :--- | :--- |
| --version=v1.0.0 | -v v1.0.0 | 设置 package 的版本 |
| --license=MIT | -l MIT | 设置 package 所遵循的版权协议 |
| --submodule | -s |删除 git 子模块 |

## 参数说明
| 参数 | 描述 |
| :--- | :--- |
| --version=v1.0.0 | 设置 package 的版本 |
| --license=MIT | 设置 package 所遵循的版权协议 |
| --remove-submodule | 删除 git 子模块 |
---
## Windows10 及 Linux 平台的演示动图
![buildpkg](/figures/buildpkg.gif)
---

## 测试平台

| 序号 | 测试平台 | 测试结果 |
|:---|:---|:---|
| 1 | win10 | exe测试通过 |
| 2 | win7 | 待测试 |
| 3 | mac | py脚本不知道是否兼容, 没有测试条件, 后面维护下 |
| 4 | ubuntu | py脚本不知道是否兼容, 没有测试条件, 后面维护下 |
| 1 | win10 | exe测试通过, py测试通过 |
| 2 | win7 | exe待测试, py待测试 |
| 3 | mac | py脚本不知道是否兼容, 没有测试条件, 后面维护下 |
| 4 | linux | py脚本不知道是否兼容, 没有测试条件, 后面维护下 |

## 联系人

Expand Down

0 comments on commit 687c3e9

Please sign in to comment.