From 4526dcd643c2aab2121c433dc2f7605b686b74ea Mon Sep 17 00:00:00 2001 From: lshelen23 Date: Sun, 24 Oct 2021 06:17:26 +0000 Subject: [PATCH 1/2] Optimized the readme, with few grammar issues corrected --- README.md | 44 ++++++++++++++++++++++++-------------------- 1 file changed, 24 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 9c1dbc2..42f006b 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,44 @@ -# rubyporter +# RubyPorter #### Description -A rpm packager bot for ruby modules from rubygems.org -It is a tool to create spec file and create rpm for ruby modules. -#### Installation - -python3 setup.py install +This is an RPM packager bot for Ruby modules from [rubygems.org](rubygems.org). This bot allows you to create **spec** files and create RPM for Ruby modules. #### Preparation -Install below sofware before using this tool -* gcc -* gdb +Install the following software before using the RubyPorter. + +* GCC +* GDB * libstdc++-devel * ruby-devel * rubygems-devel -### Instructions -1. Create spec file, *rubyporter -s xxx*, add *-o xxx* to save to a file +#### Installation + +Run **python3 setup.py install** to install. + +#### Instructions + +1. Run **rubyporter -s xxx** to create a **spec** file named ***xxx***, note that this should be an existed tool in the RubyGems package. Run **-o *yyy*** to save the specification log to the ***yyy*** file. + ``` -e.g. rubyporter -s puma (generate and display in the screen) +e.g. rubyporter -s puma (generate and display the spec log on the screen) - rubyporter -s puma -o rubygem-puma.spec (generate and save to a file) + rubyporter -s puma -o rubygem-puma.spec (generate and save the spec log to rubygem-puma.spec) ``` -2. Build rpm package, *rubyporter -b xxx* +2. Build an RPM package in the name ***rubyporter -b xxx***. -3. Build and Install rpm package, *rubyporter -B xxx* +3. Build and Install the RPM package, ***rubyporter -B xxx***. -4. For more details, please use *rubyporter -h* +4. For more details, please use ***rubyporter -h***. #### Contribution -1. Fork the repository -2. Create Feat_xxx branch -3. Commit your code -4. Create Pull Request + +1. Fork the repository. +2. Create a **Feat_xxx** branch. +3. Commit your code. +4. Create a pull request. -- Gitee From 815d78f899160d0ea6ae02b359f4ee28c76ba53d Mon Sep 17 00:00:00 2001 From: lshelen23 Date: Sun, 24 Oct 2021 06:21:28 +0000 Subject: [PATCH 2/2] Updated the Chinese version of Readme. --- RubyPorter-ZN.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 RubyPorter-ZN.md diff --git a/RubyPorter-ZN.md b/RubyPorter-ZN.md new file mode 100644 index 0000000..a9c4d9c --- /dev/null +++ b/RubyPorter-ZN.md @@ -0,0 +1,52 @@ +# RubyPorter + +#### 描述 + +这是[rubygems.org](rubygems.org)上Ruby模块的RPM打包机器人。使用此机器人,您可以创建**spec**文件并为Ruby模块创建RPM。 + +#### 准备工作 + +在使用RubyPorter之前安装以下软件。 + +* GCC + +* GDB + +* libstdc++-devel + +* ruby-devel + +* rubygems-devel + +#### 安装 + +运行**python3 setup.py install**进行安装。 + +#### 操作 + +1. 运行**rubyporter -s xxx**来创建一个名为***xxx***的**spec**文件,注意***xxx***应该是RubyGems包中存在的一个工具。运行**-o *yyy***来保存spec记录到***yyy***文件。 + +``` + +e、 g.rubyporter-s puma(生成并显示配置记录) + + rubyporter-s puma-o rubygem-puma.spec(保存spec记录到rubygem-puma.spec文件) + +``` + +2. 以***rubyporter-b xxx***的名称构建RPM包。 + +3. 构建并安装RPM包***rubyporter-B xxx***。 + +4. 有关更多详细信息,请使用***rubyporter-h***。 + +#### 贡献 + +1. Fork此软件仓。 + +2. 创建**Feat_xxx**分支。 + +3. 提交代码。 + +4. 创建PR。 + -- Gitee