From bf48ecb9ffae5c20d41fe5047c5cdff640880f8c Mon Sep 17 00:00:00 2001 From: ruki Date: Thu, 22 Aug 2019 22:18:44 +0800 Subject: [PATCH] update readme --- CONTRIBUTING.md | 2 ++ README.md | 2 ++ README_zh.md | 2 ++ 3 files changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 635b4cb72..8ece56c5f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,6 +20,7 @@ try to follow these guidelines when you do so. * Write good commit messages. * Use the same coding conventions as the rest of the project. * Ensure your edited codes with four spaces instead of TAB. +* About how to make a package, please see [Create and Submit packages to the official repository](https://xmake.io/#/package/remote_package?id=submit-packages-to-the-official-repository) # 贡献代码 @@ -40,5 +41,6 @@ try to follow these guidelines when you do so. * 请使用余工程代码相同的代码规范 * 确保提交的代码缩进是四个空格,而不是tab * 为了规范化提交日志的格式,commit消息,不要用中文,请用英文描述 +* 关于如何制作包,请参看文档:[制作和提交到官方仓库](https://xmake.io/#/zh-cn/package/remote_package?id=%e6%b7%bb%e5%8a%a0%e5%8c%85%e5%88%b0%e4%bb%93%e5%ba%93) [1]: https://github.com/xmake-io/xmake-repo/issues diff --git a/README.md b/README.md index b6bc06e92..8e6ec9b9e 100755 --- a/README.md +++ b/README.md @@ -61,6 +61,8 @@ Write a xmake.lua of new package in `packages/x/xxx/xmake.lua` and push a pull-r For example, [packages/z/zlib/xmake.lua](https://github.com/xmake-io/xmake-repo/blob/dev/packages/z/zlib/xmake.lua): +If you want to known more, please see: [Create and Submit packages to the official repository](https://xmake.io/#/package/remote_package?id=submit-packages-to-the-official-repository) + ```lua package("zlib") diff --git a/README_zh.md b/README_zh.md index 367e221d0..de89245ea 100755 --- a/README_zh.md +++ b/README_zh.md @@ -61,6 +61,8 @@ xmake-repo是一个官方的xmake包管理仓库,收录了常用的c/c++开发 例如:[packages/z/zlib/xmake.lua](https://github.com/xmake-io/xmake-repo/blob/dev/packages/z/zlib/xmake.lua): +关于如何制作包的更详细描述,请参看文档:[制作和提交到官方仓库](https://xmake.io/#/zh-cn/package/remote_package?id=%e6%b7%bb%e5%8a%a0%e5%8c%85%e5%88%b0%e4%bb%93%e5%ba%93) + ```lua package("zlib")